Format d'entrées
L'interrogation de l'API se fait au moyen de requêtes HTTP en utilisant GET ou POST.
Afin qu'elles soient reçues correctement, les données que vous aller envoyer à l'API doivent être url encodées . Il s'agit d'une fonctionnalité commune et automatique de la plupart des librairies HTTP que vous pourrez utiliser.
Format de sorties
L'API retourne des données au format JSON. Le Content-Type des données renvoyées par l'API sera application/json; charset=utf-8
Le status code HTTP sera différent selon que l'appel sera réussi ou échoué.
Appel réussi - status code 200
Par exemple un appel à la function Test.Echo retournera une structure JSON telle que :
{
ResponseType : "ok",
message : "Success",
QueryLeft : 995,
data : "mon paramètre"
}Appel échoué - status code 500
Il peut arriver que les paramètres que vous passez à une fonction ne soit pas adéquat, dans ce cas c'est une structure JSON représentant une erreur qui sera renvoyée.
Par exemple un appel à la fonction Test.Error retournera une structure JSON telle que :
{
ResponseType : "error",
message : "Example error",
QueryLeft : 991,
data : false
}