Vue d’ensemble

Dans Sage 100, chaque requête à l’API Sage 100 va retourner un code de statut HTTP. Ceci donne immédiatement une information sur le succès ou l’échec de la requête.

Ci-dessous un résumé des codes de statut retournés par l’API Sage 100.

code HTTP	Message	Description
200	OK	Requête de sélection exécutée avec succès
201	Created	Requête de création de ressource exécutée avec succès
202	Accepted	Requête exécutée mais sans garantie de résultat
204	No Content	Requête de modification ou suppression exécutée avec succès
400	Bad Request	La syntaxe de la requête est erronée
401	Unauthorized	Une authentification est nécessaire pour accéder à la ressource
403	Forbidden	Accès à la ressource non autorisé
404	Not Found	Le chemin n’existe pas
405	Method Not Allowed	La demande a été faite en utilisant le mauvais verbe HTTP
415	Unsupported Media Type	Le média/langue transmis dans la demande n’est pas pris en charge
422	Unprocessable Entity	Des données non valides ont étés transmises et la demande ne peut pas aboutir
429	Too Many Requests	Trop de demandes ont été faites contre l’API. Cela provoque une erreur de limitation
500	Internal Server Error	Un bug a été rencontré dans notre application
503	Service Unavailable	Un des serveurs requis pour cette demande n’a pu être atteint. Veuillez réessayer plus tard

Principales réponses

200 OK

Le code 200 - OK confirme que l’appel à l’API a réussi. La réponse affichera les données demandées par la requête GET.

201 Created

Le code 201 - Created confirme qu’une requête POST auprès de l’API a réussi. Cela confirme également que la ressource a été créée avec succès dans le cadre de la demande.

204 No Content

Le code 204 No Content est renvoyé quand l’appel à l’API a réussi mais sans données à renvoyer (cas des requêtes PUT, PATCH et DELETE). Cela apparait souvent lorsque la requête DELETE a réussi. Le message indique aucun contenu et le corps de la réponse est vide.

401 Unauthorized

Le code 401 - Unauthorized peut être retourné pour plusieurs raisons.
L’une des raisons les plus courantes est celle lorsque le jeton d’accès aura expiré. Cela peut être résolu en actualisant le jeton d’accès.

D’autres raisons sont possibles:

• Le jeton a été révoqué.
• Le jeton est invalide, mal structuré ou n’a pas été transmis.
• L’utilisateur n’est pas trouvé dans la base de données.
• L’utilisateur n’a pas d’abonnement valide, la période d’essai a expiré.

Le code401 - Unauthorized peut aussi être renvoyé pour la raison suivante (lorsqu’il ne s’agit pas AccessTokenExpiredError) l’utilisateur doit être autorisé à nouveau. Tous les jetons d’actualisation précédemment stockés doivent être supprimés du client.

403 Forbidden

Ce code indique que l’utilisateur ne dispose pas des autorisations nécessaires pour réaliser l’action demandée. Par exemple, un POST est exécuté sur une ressource alors que l’utilisateur n’est autorisé qu’au GET.

404 Not Found

Cette réponse est retournée si la route/ressource demandée n’existe pas.

405 Method not Allowed

Un code de réponse 405 - Method Not Allowed indique que le verbe HTTP utilisé n’existe pas . Afin de vérifier les verbes disponibles consulter la documentation de référence de l’API.

429 Too Many Requests

Le code429 - Too Many Requestsest renvoyé lorsque l’application dépasse les limites ou les quotas.

500 Internal Server Error

Erreur interne du serveur généralement dû à une erreur métier ou erreur de cohérence des données (ressource déjà verrouillée écriture, longueur affectée dépassant la capacité de la propriété…)