Messages de réponse

Modifier en ligne

Informations sur les différentes erreurs et messages de réponse renvoyés par les interfaces de programmation d'applications (API) de Verify.

Les codes de statut HTTP indiquent si une opération a abouti. Les types d'erreurs suivants peuvent apparaître lorsque vous envoyez des requêtes et recevez des réponses des Verify API :

2xx success: Indique le statut de réussite de l'opération.
4xx client errors: Indique un problème lié à la demande envoyée par l'application client. Corrigez le problème de la demande avant de soumettre à nouveau la demande.
5xx server errors: Indique un problème lié au serveur. Renvoyez ou retentez la demande jusqu'à ce qu'elle aboutisse.

Le corps de la réponse contient un identificateur de message (messageId) et un texte qui est traduit selon les paramètres régionaux du demandeur (messageDescription).

Tableau 1. Messages de réponse
Code de statut HTTP	Descriptif
200	Récupération réussie d'un objet
201	Création réussie d'un objet
202	La demande a été acceptée mais pas terminée (opération asynchrone).
204	L'opération demandée, telle que la mise à jour ou la suppression d'un objet, a abouti.
207	Statut multiple - mélange des résultats renvoyés. Ce statut peut se produire avec des opérations PATCH et globales.
400	Demande incorrecte. La demande a été incorrectement formée ou ne peut pas être traitée. Les paramètres d'entrée peuvent contenir des valeurs non valides.
401	Le client n'a pas été authentifié. Par exemple, le jeton d'accès utilisé n'est pas valide.
403	Accès interdit. Par exemple, le jeton d'accès n'autorise pas l'accès à la ressource demandée.
404	Ressource introuvable. Les informations demandées n'existent pas.
405	La méthode HTTP spécifiée dans la demande n'est pas prise en charge par la ressource.
406	La ressource ne peut pas produire de représentation spécifiée dans l'en-tête Accept de la demande.
409	Les informations existent.
415	La ressource ne peut pas consommer la représentation spécifiée dans l'en-tête Content-Type de la requête.
429	Nombre de demandes trop élevé
500	Une erreur interne du serveur s'est produite lors du traitement de la demande.
501	La méthode demandée a été désactivée.
502	La notification n'a pas été envoyée.

Si toutes les opérations aboutissent lors des opérations PATCH, le statut

est renvoyé. Si une ou plusieurs erreurs se produisent, un statut 207 est renvoyé et le client peut analyser les résultats.

Si toutes les opérations aboutissent lors des opérations bulk management, comme POST ou DELETE, un statut

est renvoyé. Si une ou plusieurs erreurs se produisent, un statut 207 est renvoyé et le client peut analyser les résultats.

Pour le traitement d'erreurs, utilisez le code réponse HTTP et le messageId du corps de réponse de l'erreur. L'élément messageDescription doit être utilisé à des fins d'information uniquement, et il peut être modifié. De telles modifications ne constituent pas des modifications de la sémantique d'API.