Codes de retour et troubleshooting
HTTP, données retournées à prendre en compte
Lorsqu'un client HTTP se connecte à un serveur, il obtient systématiquement un corps (il s'agira par exemple de la page web affichée par un navigateur) et également des informations non affichées, telle que le code de retour.
Dans le cas d'une requête API, ces deux éléments sont également présents : le code de retour est systématique, de même que le corps. Si tout s'est bien passé, le corps contient les éléments demandés (dans le cas d'un GET ou d'une recherche), sinon, il contient des informations utiles pour le déboggage des requêtes : la liste des codes de retour HTTP est assez limitée, et ils ne permettent pas, seuls, d'efficacement traiter les erreurs rencontrées.
Aussi, lors du développement d'un connecteur à nos API, nous vous conseillons, dans les premières étapes, de systématiquement récupérer ET le code de retour ET le corps de la response HTTP. Il sera en prime impossible à notre Service Client de vous apporter de l'assistance sur le développement de votre connecteur sans ses deux informations.
Mail automatique quotidien
Le connecteur API intégré à la plateforme liste les erreurs rencontrés par un client donné, et les envoie par mail à l'adresse associée à la clef API. Ce mail liste l'ensemble des erreurs, et permet facilement d'avoir un état quotidien des envois et de mettre en place d'éventuelles actions correctives.
Si vous ne recevez pas ce mail, contactez le Service Client Intent Technologies (et vérifier que vous ne filtrez pas les mails envoyés par serviceclient@intent.tech et support@intent.tech ).
Codes de retour (succès)
Les codes de retour commençant par 2xx sont des codes de retour indiquant que l'opération demandée s'est bien déroulée, ou qu'elle est en cours, sans détection de problème. Il est à noter que le code de retour est modifié en fonction de la nature de l'opération.
200
OK
La requête a été correctement prise en compte. Normalement aucun nouvel objet n'a été créé (les modifications et les requêtes de lecture remontent des code 200).
201
Created
La requête a été correctement prise en compte et la création demandée a bien été effectuée. Les requêtes d'ajout ou de création (PUT) remontent des codes 201.
202
Accepted
La requête a été correctement prise en compte, mais son traitement est asynchrone. Cela implique que l'intégration des données va être effectuée avec un délai éventuel.
204
NoContent
La requête a été correctement pris en compte. Il n'y a pas de contenu à envoyer dans le corps de la réponse
Codes de retour (erreur)
Les codes de retour commençant par 4xx et 5xx sont les codes de retour indiquant que l'opération demandée s'est mal déroulée. Les codes en 4xx signalent un problème détecté par le client ou portant sur la communication client-serveur. Les codes en 5xx signalent un problème interne au serveur.
400
Bad Request
La syntaxe de la requête est erronée.
401
Unauthorized
Une authentification est nécessaire pour accéder à la ressource. Vous avez sans doute un problème sur le token. Il est peut-être expiré.
403
Forbidden
Vos droits d'accès ne vous permettent d'effectuer la requête demandée.
404
Not Found
Ressource non trouvée. L'asset ou le contrat indiqué dans votre requête n'existe pas.
408
Request Time-out
Temps d’attente d’une requête du client, écoulé côté serveur. Vous pouvez répéter la demande sans modifications à tout moment ultérieur.
429
Too Many Requests
Vous avez dépassé le nombre maximum de requête autorisé (600 requêtes/min)
Erreur 404 sur une intervention
Lorsque vous publiez une intervention, un devis ou une réserve et que vous recevez une erreur 404, l'erreur est très probablement liée au fait que la référence de l'asset ou du contrat indiquée dans votre requête n'est pas bonne. Vous pouvez vous en rendre compte rapidement sur les interfaces web ou via une requête API.
Avec une requête API :
GET {url_de_base}/api/assets/v1/assets/{reference}
GET {url_de_base}/contracts/v1/contracts/{reference}
Si vous recevez une erreur 404, c'est que votre asset ou contrat n'existe pas sur votre entité d'IntentPlatform.
Avec les interfaces web :
Référence de l'asset : Il faut aller dans l'univers Patrimoine. Vous tapez la référence de l'asset dans le moteur de recherche et vous voyez tout de suite si votre asset existe ou non.
Référence de contrat : Il faut aller dans l'Administration, puis Contrat. Vous retrouvez le listing de vos contrats avec leur référence. Vous pouvez rapidement vérifier si votre contrat existe ou non.
500
Internal Server Error
Erreur interne du serveur
502
Bad Gateway
Le serveur a reçu une réponse invalide depuis le serveur distant.
Les codes de retour 5xx signifient que le serveur appelé a retourné une erreur interne ou lors d'un appel à un serveur tiers.