Résultats de l’API

Structure d’un résultat réussi

Un résultat d’API réussi ressemble à ceci :

{
        "status": 0,
        "result": "API result"
}

Selon l’appel API, result peut contenir n’importe quel type de contenu (chaîne, nombre, tableau, objet, etc.).

Un exemple de résultat numérique (par exemple un nombre d’utilisateurs) :

{
        "status": 0,
        "result": 10
}

Exemple d’objet de résultat (par exemple un utilisateur) :

{
        "status": 0,
        "result": {
                "name": "Some user",
                "username": "apiexample",
                "email": "user@example.com"
        }
}

Structure d’un résultat d’erreur

Lorsqu’un appel API échoue, le résultat ressemble à ceci :

{
        "status": -1,
        "message": "The reason the API call failed"
}

Codes d’état par défaut

Le champ status contient toujours un nombre représentant le résultat. Toute valeur autre que 0 est considérée comme une erreur.

• 0 : C’est un résultat réussi

• -1 : Il s’agit d’un résultat d’erreur générique

• -20 : le jeton d’authentification utilisateur est manquant, est invalide ou a expiré

• -30 : La clé api a été désactivée

• -31 : La clé api est inactive

• -32 : La clef api est invalide

Les développeurs peuvent implémenter leurs propres codes d’état pour représenter différents états d’erreur, de sorte que la demande n’a pas à s’appuyer sur le message d’erreur pour savoir ce qui s’est passé.

Note

result et message peuvent contenir des messages dans différentes langues. Cela dépend de la langue utilisateur lors de l’utilisation d’appels API authentifiés par l’utilisateur ou de la langue de site pour les autres appels API. Gardez à l’esprit que la langue peut changer, que ce soit par l’utilisateur ou par un administrateur du site pour la langue du site.