Sign In App Documentation

Voici une liste de codes de réponse qui pourraient être émis par les endpoints de l'API Sign In App. Dans la mesure du possible, chaque endpoint documente les exigences spécifiques en matière de paramètres et les erreurs possibles propres à cet endpoint.

200 OK

Ce code est renvoyé pour la plupart des autres appels API réussis, y compris GET, PUT, PATCH et DELETE. Les données renvoyées représentent la ressource demandée.

201 Created

Ce message est renvoyé lorsqu'une nouvelle ressource de l'API est créée. 201 est renvoyé pour confirmer que l'appel de ressource a réussi. La réponse contient généralement l'entité nouvellement créée.

401 Unauthorized

Les informations d'identification de l'API utilisées n'existent pas ou l'authentification a échoué. Vérifiez que l'en-tête authentication est correctement défini et qu'il contient les informations correctes.

403 Forbidden

Une vérification des permissions pour le endpoint spécifié a échoué pour le client API utilisé. Vérifiez dans le portail les autorisations associées au client utilisé.

405 Method Not Allowed

Ceci est souvent dû au fait que le endpoint n'accepte pas le verbe HTTP spécifié. Vérifiez la documentation de ce endpoint et les méthodes HTTP supportées.

422 Unprocessable Entity

Lorsque la validation des champs fournis dans une requête échoue, un objet JSON contenant chaque champ ayant échoué est renvoyé avec une description de la raison.

Object {
String <key>: Array[String]
}

Exemple

{
"name": [
"Name is a required field."
],
"mobile": [
"The specified mobile number is not valid."
]
}

429 Too Many Requests

L'API Sign In App met en œuvre un système d'étranglement sur tous les endpoints. Veillez à limiter le nombre de requêtes à un maximum de 20 par minute. Si cette limite est dépassée, cette réponse sera renvoyée jusqu'à ce que la minute soit écoulée.

500 Internal Server Error

Si un problème survient au cours de l'exécution et qu'il ne peut être renvoyé sous la forme d'un message d'erreur utile, l'API Sign In App renverra cet état. Des systèmes internes sont mis en place pour surveiller ces erreurs et y répondre de manière appropriée.

503 Service Unavailable

Nous effectuons parfois des opérations de maintenance qui peuvent nécessiter un temps d'arrêt minimal. Ce statut est émis pendant cette période. Les demandes doivent être mises en file d'attente et réessayées ultérieurement.