Communiquer

Voici tous les détails concernant la communication avec l'API.

Envoyer une requête

Pour les détails concernant la racine, l'authentification, etc... rendez-vous sur la page Réference.

L'api utilise le protocole HTTPS, pour envoyer une requête il vous suffit de faire une requête HTTP avec le client de votre choix.

GET /stock/gateau HTTP/1.1
Host: api.edu-focus.org
Authorization: Basic Q2VjaSBlc3QgZXZpZGVtZW50IHVuIGZhdXggdG9rZW4=

Méthodes

L'api accepte les méthodes suivantes.

Méthode

Description

GET

Permet d'obtenir une ressource.

PATCH

Permet de modifier une ressource.

POST

Crée une nouvelle ressource

PUT

Crée une ressource avec un identifiant défini ou la modifie si elle existe déjà.

DELETE

Supprime une ressource ou la déplace vers un état final.

Entêtes

Certaines entêtes sont prises en compte pas l'api.

Entête

Facultative

Description

Content-Type

Type du contenu que vous envoyez à l'api.

Corps

Parfois, il y à besoin d'envoyer des données au serveur, notamment pour les endpoints utilisant la méthode PUT et POST. Dans ces cas là, le contenu doit être envoyé au serveur sous la forme d'un objet JSON [EN] valide.

Lorsque vous envoyez du contenu à l'api, assurez vous que l'entête Content-Type est correctement définie.

N'envoyez jamais de formulaire à l'api, il ne seront pas traités.

Réponses

Lorsque vous faites une requête à l'api, vous devez vous attendre à une réponse, la réponse de l'api est toujours en JSON [EN].

Succès

Les requêtes aboutissant correctement auront un code commençant par 2 (2xx) voici un exemple de réponse réussie. Les codes les plus plausibles sont 200, 201 et 204. La réponse contiendra un objet représentant la ressource que vous avez demandés s'il y a lieu.

La réponse peut également être vide dans le cas ou votre requê

Données de la requête

Si la requête consiste à récupérer des données auprès d'Edu-Focus, ces données alors l'api vous renverra une ressource sous le format indiqué par la documentation.

La réponse, si présente, sera toujours en JSON [EN].

Voici un exemple de réponse réussie avec des données :

{
"stocks": [
{"name": "Forêt noire", "quantity": 4},
{"name": "Baba au rhum", "quantity": 5},
{"name": "Fraisier", "quantity": 0},
{"name": "Paris-brest", "quantity": 12},
]
}

L'espacement de la réponse n'est pas garantie. Ainsi l'api peut vous répondre avec du JSON [EN] compact ou formatté.

Erreur

Les requêtes n'aboutissant pas correctement auront un code commençant soit par 4 (400-499) soit par 5 (500-599). Elle peuvent contenir un objet JSON [EN] détaillant l'erreur. Voici un exemple d'erreur JSON:

{
"code": 0,
"message": "Malformed JSON"
}

Pour tous les détails concernant les codes d'erreurs HTTP et JSON, consultez cette page: