'; ';
  • Accueil
  •  > 
  • Fonctionnement de l’API
<

Fonctionnement de l’API

Accès à l’API

Le point d’entrée de l’API est :

Toutes les commandes de l’API se basent sur cette url. Les paramètres qui correspondent aux commandes peuvent être invoqués avec les méthodes POST ou GET.

Paramètres

Certains paramètres sont obligatoires.

  1. service : qui correspond au nom de la commande à exécuter
  2. key : votre clé d’accès à l’API

Résultat du service

Format

Il est possible de préciser le format de retour des services web. L’API vous offre le choix entre les formats xml et json. Pour du xml, vous devez précisez ce paramètre dans l’url :

Pour du json :

Si ce paramètre n’est pas précisé, le résultat sera sous la forme d’un xml.

Enveloppe

Une enveloppe accompagne systématiquement la réponse de la plateforme. Elle permet de repréciser la demande et d’indiquer le statut de la réponse.

Balise Description
request url de la requête envoyée
answer enveloppe le statut de la réponse et les données
status code et libellé du statut du résultat
data résultat de la commande

Code des statuts de retour

L’enveloppe de réponse comprend un code qui indique si l’opération s’est bien déroulée, où au contraire, l’origine du problème.

Code Description
0 La commande s’est exécutée avec succès.
1 La clé d’utilisation de l’API n’est pas valide.
3 La commande demandée n’est pas valide.
4 La clé d’utilisation de l’API est vide.
6 La commande est vide.
7 Erreur interne.
8 Nombre limite de requête atteinte.