Ecoledirecte Api Documentation

Une doc permettant de comprendre l'api de ecoledirecte.

Introduction

Bienvenue sur la documentation non officielle de l'api d'ecoledirecte. Cette documentation est inspirée d'un autre projet github ('ecoledirecte-api-docs') 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 SpacyXyt)

Sommaire

Un simple sommaire afin de naviguer facilement entre les différentes catégories.

• Introduction
• Login

Format de la documentation

Les requêtes prennent soit des query string dans l'URL (ex: https://api.ecoledirecte.com/example.awp?requete=requête) soit du JSON dans le corp de la requête, example:

.fetch('https://api.ecoledirecte.com/example.awp', {
    method: 'POST',
    headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        "requete": "marequete"
    })
});

Important: Toutes demande à l'api sont effectuer en POST (method: 'POST'). Il faut aussi envoyer un paramètre verbe (/example.awp?verbe=POSTE) utilisé pour spécifier le verbe HTTP. Ici nous n'utiliseront pas ce paramètre, en vue du fait que même sans celui-ci la requête est fonctionel.

Réponse de l'api:

{
  "host": "HTTP<n° serveur>",
  "code": 200, // Ou autre en cas d'erreur
  "token": "<token>",
  "message": "", // Rarement présent hors erreur, sinon en cas d'erreur
  "data": {...},
}

Voici à quoi ressemble une réponse que pourrez vous envoyez l'api. Voici à quoi corresponde les differente partie de la réponse: "host": "HTTP<n° serveur>",: Cette ligne correspond au serveur vers ou votre demande à été envoyer, nous y reviendront dans la partie sur les serveur. "code": 200,: Cette ligne correspond au code que le serveur vous renvoie, vous verez les different code que le serveur peut vous renvoyez dans la partie Code. "token": "<token>",: Cette ligne correspond à votre token, c'est avec cette clé que vous pourrez vous autentifiez sans devoir entrer le mot de passe à chaque fois. "message": "",: Cette ligne correspond à la traduction du code de la ligne 2, vous pourrez voir le message d'erreur ou de réussite.

Important: Mais dans l'api il n'y aura que les données dans data qui vont seront vraiment utiles, c'est dans cette partie de la réponse que vous trouverez ce que vous avez demander à l'api.

Login