Réponses API (Succès et Erreurs)

Les codes de réponse doivent être interprétés selon la norme rfc7231

Succès

En cas de succès, les API retournent un des codes suivants

Code	Signification	Action recommandée
200	succès
201	La resource est créé
202	La requête est acceptée	Selon l'API, il est possible qu'une action supplémentaire nécessaire pour créer la resource. Se référer à la documentation de l'API
204	La requête est traité avec succès, aucune action supplémentaire n'est nécessaire
301	succès avec redirection	Si vous avez réalisé un appel browser, le browser va rediriger l'utilisateur sur la page de redirection. Sinon (example d'un appel AJAX), vous devez écrire le code de redirection en parsant la réponse
302	succès avec redirection	Même chose pour 301

Les messages d'erreurs renvoyés par nos API sont au format json et doivent être interprétés selon la référence rfc7807 section-3

Example de réponse en cas d'erreur

{
	"status": 400,
	"title": "BAD_REQUEST",
	"details": "bearer token or apikey is missing",
	"source": "onboarding"
}

En cas d'erreurs, les API retournent un des codes suivants

Statut	Signification	Action recommandée
400	Votre requête est mal formée ou bien tous les paramètres obligatoires ne sont pas fournis	Analyser le message d'erreur
401	Votre clé d'API ou access token n'est pas valide (token expiré, clé API mal copiée, ect.)	Marquez la transaction comme échouée de votre côté
403	Vous n'avez pas les authorizations nécessaires pour executer cette action	Générer une API avec les bonnes permissions
404	Le chemin de l'API est introuvable	Revoir le chemin de l'API
500	Le service rencontre une erreur inattendue.	Peut-être due aux paramètres que vous avez passés mais qui sont inattendus par l'API. Si vous avez revu les paramètres passés à l'API et l'erreur persiste, alors vous pouvez contacter le support de Bictorys [email protected]
502	Une erreur est survenu au niveau du serveur proxy	Revoir le chemin de l'API. Si l'erreur persiste, alors vous pouvez contacter le support de Bictorys [email protected]
503	Le service n'est pas disponible	Si l'erreur persiste, alors vous pouvez contacter le support de Bictorys [email protected]