Bienvenue sur la documentation non officielle de l'api d'ecoledirecte.
Si jamais cette documentation vient a être défaillante, merci de faire une issue avec les problèmes rencontrés
(Si jamais vous avez des idées de formatage, hésitez pas à me le faire savoir MaitreRouge#1712)
Juste un rapide sommaire pour naviguer plus facilement dans la documentation
L'url de base utilisé est https://api.ecoledirecte.com/v3/ (cette doc ne se base que sur la v3).
Si jamais des informations sont a envoyer en POST, il faudra alors obligatoirement les envoyer en plain text / raw (indiqué le cas contraire).
Cela concerne toutes les routes à l'exception de /login. Il faut passer un Header à la requête avec le token (voir login):
X-Token: <token>
ATTENTION : Il faut penser à encoder certains characters en suivant ce modèle :
["%", "%25"]
["&", "%26"]
["+", "%2B"]
["\\", "\\\\"]
["\"", "\\\""]
Exemple : Votre mot de passe est "JaimeLesK++kies&Ynotes" il faudra envoyer ca "JaimeLesK%2B%2Bies%26"
Liste de differents condes erreur trouvés au fil du temps avec leur description et des solutions pour fixer le pb
Note : Les requêtes renveront (sauf grosse erreur côté serveur avec une 5xx) toujours dans leur header un code 200, même en cas d'erreur
Code: 505
Problème: Les identifiants donnés à l'api sont erronés
Solution: Il faut vérifier le nom d'utilisateur et/ou le mot de passe (cf Login)
Code: 520
Problème: Le token est invalide
Solution: Il faut regénérer un token (cf Login)
Code: 525
Problème: Le token est expiré
Solution: Il faut regénérer un token (cf Login)
Code: 40129
Problème: Format JSON invalide
Solution: Vérifier que le body de la requete a bien été envoyé en raw (ou plain text) et qu'il respecte le formatage donné dans la documentation
Voici la structure détaillée d'un utilisateur (et commentée)
{
"idLogin": 1324, //int | ???
"id": 1234, //int | Numéro de compte
"uid": "00000000000000000000000000000000", //string
"identifiant": "Username", //string | Username du compte
"typeCompte": "E", //string | Voir Type de compte dans la référence
"codeOgec": "000000000", //string | ???
"main": true, //bool | Indique si cet account est le principal (il peut en avoir plusieur comme avec un parent)
"lastConnexion": "2021-10-05 18:28", //string | Date de dernière connexion à l'api via l'endpoint login (multiples connexions possibles)
"civilite": "",
"prenom": "John",
"particule": "",
"nom": "DOE",
"email": "email@example.com",
"anneeScolaireCourante": "2050-2051",
"nomEtablissement": "Github",
"logoEtablissement": "",
"couleurAgendaEtablissement": "#1796b0",
"dicoEnLigneLeRobert": false,
"socketToken": "secret token", //string | ???
"modules": [
//Liste des modules, voir la référence pour plus
],
"parametresIndividuels": {
"lsuPoilDansLaMainBorne1": "", // ???
"lsuPoilDansLaMainBorne2": "", // ???
"lsuPoilDansLaMainBorne3": "", // ???
"modeCalculLSU": "", // ???
"isQrcode": false, // ???
"modeAccessibiliteVisuelle": false,
"typeSaisieNotesDefaut": "",
"nbJoursMaxRenduDevoirCDT": "",
"typeViewCDTDefaut": ""
},
"profile": {
"sexe": "M",
"infoEDT": "",
"nomEtablissement": "Github",
"idEtablissement": "0",
"rneEtablissement": "0000000",
"telPortable": "",
"idReelEtab": "0",
"photo": "//doc1.ecoledirecte.com/PhotoEleves/x/y.jpg",
"classe": {
"id": 44,
"code": "TB",
"libelle": "Terminale B",
"estNote": 1
}
}
}Ces modules là sont ceux disponibles dans l'object account, ils ressemblent à ça :
{
"code": "CANTINE_BARCODE", //string | Nom du module
"enable": false, //bool | Si le module est actif pour l'account en question
"ordre": 1, //int | Position dans la sidebar
"badge": 0, //int | ???
"params": {} //object | Parametres du modules
}Voici la liste des modules qui ont été documentés jusqu'a présent
{
"code": "CANTINE_BARCODE",
"enable": false,
"ordre": 1,
"badge": 0,
"params": {}
},
{
"code": "VIE_SCOLAIRE",
"enable": true,
"ordre": 10,
"badge": 0,
"params": {}
},
{
"code": "VIE_DE_LA_CLASSE",
"enable": true,
"ordre": 20,
"badge": 0,
"params": {}
},
{
"code": "NOTES",
"enable": true,
"ordre": 30,
"badge": 0,
"params": {}
},
{
"code": "CLOUD",
"enable": false,
"ordre": 90,
"badge": 0,
"params": {}
},
{
"code": "MESSAGERIE",
"enable": true,
"ordre": 40,
"badge": 0,
"params": {
"isActif": "1",
"canParentsLireMessagesEnfants": "1",
"destAdmin": "0",
"destEleve": "0",
"destFamille": "0",
"destProf": "1",
"destEspTravail": "0",
"disabledNotification": "0",
"notificationEmailEtablissement": "1",
"choixMailNotification": "0",
"autreMailNotification": "",
"mailPro": "",
"mailPerso": "",
"messagerieApiVersion": "v3",
"blackListProfActive": "0",
"estEnBlackList": "0",
"afficherToutesLesClasses": "0"
}
},
{
"code": "EDT",
"enable": true,
"ordre": 50,
"badge": 0,
"params": {}
},
{
"code": "DOCUMENTS_ELEVE",
"enable": true,
"ordre": 71,
"badge": 0,
"params": {
"DocumentsNotesActif": "1",
"DocumentsVSActif": "1",
"DocumentsAdministratifActif": "1"
}
},
{
"code": "CAHIER_DE_TEXTES",
"enable": true,
"ordre": 60,
"badge": 0,
"params": {
"compteRenduSeance": "1",
"compteRenduSeancePrevisionnel": "0",
"isCDTPrimaire": "0"
}
},
{
"code": "MANUELS_SCOLAIRES",
"enable": false,
"ordre": 62,
"badge": 0,
"params": {}
},
{
"code": "QCM",
"enable": true,
"ordre": 65,
"badge": 0,
"params": {}
},
{
"code": "RESERVATIONS",
"enable": false,
"ordre": 80,
"badge": 0,
"params": {
"regime": "Externe",
"repasmidi_1": "0",
"repassoir_1": "0",
"repasmidi_2": "0",
"repassoir_2": "0",
"repasmidi_3": "0",
"repassoir_3": "0",
"repasmidi_4": "0",
"repassoir_4": "0",
"repasmidi_5": "0",
"repassoir_5": "0",
"repasmidi_6": "0",
"repassoir_6": "0",
"repasmidi_7": "0",
"repassoir_7": "0"
}
},
{
"code": "COMMANDE_PASSAGE",
"enable": false,
"ordre": 81,
"badge": 0,
"params": {}
},
{
"code": "CARNET_CORRESPONDANCE",
"enable": false,
"ordre": 70,
"badge": 0,
"params": {}
},
{
"code": "ESIDOC",
"enable": false,
"ordre": 110,
"badge": 0,
"params": {}
},
{
"code": "EDUNAO",
"enable": false,
"ordre": 100,
"badge": 0,
"params": {}
},
{
"code": "CATER",
"enable": false,
"ordre": 90,
"badge": 0,
"params": {}
},
{
"code": "ARD",
"enable": false,
"ordre": 120,
"badge": 0,
"params": {}
},
{
"code": "PEARLTREES",
"enable": false,
"ordre": 170,
"badge": 0,
"params": {}
},
{
"code": "EDUMALIN",
"enable": false,
"ordre": 171,
"badge": 0,
"params": {}
},
{
"code": "SUIVI_STAGE",
"enable": false,
"ordre": 43,
"badge": 0,
"params": {}
},
{
"code": "CLICKNPLAY",
"enable": false,
"ordre": 171,
"badge": 0,
"params": {}
},
{
"code": "VOLTAIRE",
"enable": false,
"ordre": 175,
"badge": 0,
"params": {}
},
{
"code": "ONISEPSERVICES",
"enable": false,
"ordre": 172,
"badge": 0,
"params": {}
},
{
"code": "AVENRIA",
"enable": false,
"ordre": 173,
"badge": 0,
"params": {}
},
{
"code": "SACOCHE",
"enable": false,
"ordre": 174,
"badge": 0,
"params": {}
},
{
"code": "ETUDIANT",
"enable": false,
"ordre": 176,
"badge": 0,
"params": {}
},
{
"code": "IJBOX",
"enable": false,
"ordre": 177,
"badge": 0,
"params": {}
},
{
"code": "FUTURNESS",
"enable": false,
"ordre": 178,
"badge": 0,
"params": {}
},
{
"code": "IMPALA",
"enable": false,
"ordre": 179,
"badge": 0,
"params": {}
},
{
"code": "SITUATION_FINANCIERE",
"enable": false,
"ordre": 92,
"badge": 0,
"params": {}
}EcoleDirecte n'utilise pas qu'un seul serveur, il est possible d'obtenir des informations sur les serveurs du site en une seule requete. La raison pour laquelle cette partie est dans la partie référence c'est car cela n'a pas trop d'utilitée a vraiment parler...
Notes : Il semblerait que le fichier soit statique :c (les pings sont les mêmes depuis que j'ai commecé la doc)
Request
Endpoint: https://www.ecoledirecte.com/EDCluster/servers.json
Endpoint information: On peut noter que cet endpoit prends un argumenent get, "c" qui semble optonnel jusqu'a présent
Type of request: GET
Body:
None
Headers:
None
Response
{
"servers": [ //On va recevoir une liste d'objets comme celui ci dessous
{
"profile": "API", //string | Alterne enre API / APIP et ALL
"lastCheck": "Mon Mar 16 2020 20:55:47 GMT+0100 (CET)", // ???
"name": "api.ecoledirecte.com", //string | url du serveur
"ip": "213.32.36.118", //string | ip du serveur
"status": 1,//int | ???
"responseTime": 338.23671800643206, //float | ping
"weigth": 3, //int | ???
"timeout": false, //bool | Si le serveur a timeout
"version": "Maj du 16/03/2020 à 16h27", //string, version logicielle du serveur
"bdTested": "95", //string | ???
"elapsedTime": 338, //int | ???
"timingPhases": { //Object representatant la latence avec des détails
"wait": 78.6058100014925,
"dns": 3.143696002662182,
"tcp": 7.182815000414848,
"firstByte": 249.2012169957161,
"download": 0.10318000614643097,
"total": 338.23671800643206
},
"timings": {
"socket": 78.6058100014925,
"lookup": 81.74950600415468,
"connect": 88.93232100456953,
"response": 338.1335380002856,
"end": 338.23671800643206
},
"httptested": "HTTP76",
"nbConnexions": 1,//int | Nombre d'utilisateur connectés ??
"errorCode": "ESOCKETTIMEDOUT"
},Ici se trouve toute la documentation, assurez-vous d'avoir lu la référence avant de commencer
Request
Endpoint : https://api.ecoledirecte.com/v3/login.awp
Type of request : POST
Body :
data={
"identifiant": "Username",
"motdepasse": "Password"
}
Headers :
None
Responses :
Succès
{
"code": 200,
"token": "Super secret token here", //Token de connexion (+3100 long)
"message": "", //Utilisé pour afficher des messages d'erreur
"data": {
"accounts": [
//Liste d'utilisateur liés au compte, voir la référence pour plus
]
}
}Erreur (Mot de passe invalide)
{
"code": 505,
"token": "", //Toujours vide en cas d'erreur
"message": "Mot de passe invalide !",
"data": {
"accounts": []
}
}Erreur (Utilisateur introuvable)
{
"code": 505,
"token": "", //Toujours vide en cas d'erreur
"message": "Identifiant et/ou mot de passe invalide !",
"data": {
"accounts": []
}
}Je sais pas qui aurait besoin de la timeline mais bon (:
Request
Endpoint : https://api.ecoledirecte.com/v3/eleves/{id}/timeline.awp?verbe=get
Type of request : POST
Body :
None
Headers :
X-Token: <token>
Responses :
Succès
{
"code": 200,
"token": "Super secret token here" //String | Token de connexion
"host": "HTTP186", // ???
"data": [ //Liste des évènements relatif au compte (quelques exemples d'évènement peuvent être trouvés)
{
"date": "2021-12-05", //String | Date de l'evènement
"typeElement": "Note", //String | Type de l'event (Note / Abscence / Document / ???)
"idElement": 0, // Int | ???
"titre": "Nouvelle évaluation", //String | Titre de l'evenement
"soustitre": "ED.PHYSIQUE & SPORT.",
"contenu": "natation du 15/11/2021" //String | Contenu de l'evenement
},
{
"date": "2021-09-20",
"typeElement": "VieScolaire",
"idElement": 527,
"titre": "Absence",
"soustitre": "2 demi-journées",
"contenu": "Justifiée"
},
{
"date": "2021-09-17",
"typeElement": "Document",
"idElement": 2538,
"titre": "Nouveau document à télécharger",
"soustitre": "",
"contenu": "Invitation 50 ans"
},
{
"date": "2021-09-09",
"typeElement": "Document",
"idElement": 1144,
"titre": "Nouveau document à télécharger",
"soustitre": "",
"contenu": "Certificat de scolarité"
}
]
}Le titre est plutot clair non ?
Note : Si jamais le temps est incorrect alors data sera juste un array vide
Request
Endpoint : https://api.ecoledirecte.com/v3/E/{id}/emploidutemps.awp?verbe=get
Type of request : POST
Body :
data={
"dateDebut": "2021-12-15",
"dateFin": "2021-12-15",
"avecTrous": false
}
Headers :
X-Token: <token>
Responses :
Succès
{
"code": 200,
"token": "Super secret token here" //String | Token de connexion
"host": "HTTP186", // ???
"data": [
{
"id": 46234, //int | Semble être un identifiant unique du cours
"text": "NUMERIQUE SC.INFORM.", //string | Nom du cours (peut diférer de la matière)
"matiere": "NUMERIQUE SC.INFORM.",
"codeMatiere": "NSINF", //string | Code matière interne au service ED
"typeCours": "COURS", //string | Semble varier (COURS / PERMANENCE)
"start_date": "2021-12-15 08:00",
"end_date": "2021-12-15 08:55",
"color": "#91b2bc", //string | Couleur hex du cours sur l'edt
"dispensable": false, //string | Si l'élève doit se rendre en cours
"dispense": 0, //int | Rhalala, le sport (:
"prof": "MaitreRouge",
"salle": "SALLE 11 INFO",
"classe": "", //string | vide si est dispensé dans plusieures classes
"classeId": 0, //int | ID de la classe dans laquelle le cours est dispensé (0 si est dispensé dans plusieures classes)
"classeCode": "", //int | Code de la classe (je pense qu'on a compris avec le temps que c'était vide si la cours était dispensé dans plusieures classes)
"groupe": "T_NSINF-1", //string | Nom du groupe (si dispensé dans plusieures classes)
"groupeCode": "T_NSINF-1",//string | Code du groupe
"isFlexible": false, //bool | ???
"groupeId": 2004, //int | ID du groupe
"icone": "", //string | Depuis quand on peut avoir des icones ?
"isModifie": false, //bool | ???
"contenuDeSeance": false, //bool | false même si du contenu est posté
"devoirAFaire": false, //bool | false même si un devoir est posté
"isAnnule": false //bool | Si le cours est annulé (franglais dégeu)
},
{
"id": 78905,
"text": "ANGLAIS LV1",
"matiere": "ANGLAIS LV1",
"codeMatiere": "AGL1",
"typeCours": "COURS",
"start_date": "2021-12-15 10:00",
"end_date": "2021-12-15 10:55",
"color": "#ff66cc",
"dispensable": false,
"dispense": 0,
"prof": "Florian L",
"salle": "SALLE 44",
"classe": "Terminale B",
"classeId": 44,
"classeCode": "TB",
"groupe": "",
"groupeCode": "",
"isFlexible": false,
"groupeId": 0,
"icone": "",
"isModifie": false,
"contenuDeSeance": false,
"devoirAFaire": false,
"isAnnule": false
}
]
}Endpoint qui sert a afficher les données sur la page vie de classe
Request
Endpoint : https://api.ecoledirecte.com/v3/eleves/{id}/viescolaire.awp?verbe=get
Type of request : POST
Body :
None
Headers :
X-Token: <token>
Responses :
Succès
{
"code":200,
"token":"Super secret token here",
"host":"HTTP74",
"data":{
"absencesRetards":[
{
"id":2936, //int | Identifiant interne de l'abscence / retard
"idEleve":0, //int | Normalement égal à l'id de l'eleve mais 0 dans mon cas
"nomEleve":"", //string | Normalement rempli mais vide dans mon cas
"typeElement":"Absence", //string | Sert pour savoir si c'est une abscence ou un retard
"date":"2021-11-19",
"displayDate":"le vendredi 19 novembre 2021 de 08:30 à 16:30",
"libelle":"2 demi-journées",
"motif":"",
"justifie":true, //bool | Si jamais justufié ou non (note : si jamais elle est en attente de justification, elle sera a true)
"par":"",
"commentaire":"Merci de bien vouloir excuser l'absence de X pour la journée, il est souffrant.\nBien cordialement,",
"typeJustification":" en attente de prise en compte par la vie scolaire",
"justifieEd":true,
"aFaire":"",
"dateDeroulement":""
}
],
"sanctionsEncouragements":[
{
"id":48,
"idEleve":0,
"nomEleve":"",
"typeElement":"Punition",
"date":"2021-11-26",
"displayDate":"",
"libelle":"RETENUE",
"motif":"Trop de mots dans le carnet",
"justifie":false,
"par":"",
"commentaire":"",
"typeJustification":"",
"justifieEd":false,
"aFaire":"1 heure",
"dateDeroulement":"S'est déroulé le mer. 08 décembre<BR>de 13:00 à 14:00"
}
],
"parametrage":{
"justificationEnLigne":true,
"absenceCommentaire":true,
"retardCommentaire":true,
"sanctionsVisible":true,
"sanctionParQui":false,
"sanctionCommentaire":true,
"encouragementsVisible":false,
"encouragementParQui":false,
"encouragementCommentaire":false
}
}
}