Introduction aux API

Vue d'ensemble

Les API ZigZag sont conçues pour les développeurs qui souhaitent créer des solutions et des intégrations innovantes avec la plateforme ZigZag. Les API ZigZag reposent sur une architecture REST; les contenus des requêtes et des réponses sont fournis au format JSON.

L'API Returns permet de gérer les retours en temps réel.

L'API Webhooks permet le transfert de données en temps réel en envoyant des notifications événementielles aux endpoints abonnés.

Codes de réponse

ZigZag utilise les codes de réponse HTTP standards pour indiquer la réussite ou l'échec d'une requête API. La liste ci-dessous explique la signification des principales plages de codes.

• Plage 2xx - Succès
• Plage 4xx - Erreur côté client (le code d'erreur et la réponse fournissent plus d'informations)
• Plage 5xx - Erreur sur les serveurs ZigZag (rare)

Les réponses d'erreur contiennent des messages détaillés pour aider à diagnostiquer et résoudre les problèmes.

Authentification

Lorsque vous créez un compte, un nom d'utilisateur API et un mot de passe vous sont fournis.

1. Vous devez d'abord obtenir un jeton JWT avec l'API POST /token.
2. Le jeton obtenu doit ensuite être utilisé dans toutes les requêtes suivantes via l'en-tête Authorization. Exemple : Authorization: Bearer qwe123.rty

La validité du jeton expire toutes les 30 minutes. Si une réponse 401 (Unauthorized) est reçue, un nouveau jeton doit être généré.

Politique de nouvelle tentative

Si un événement webhook reçoit l'une des réponses suivantes de l'API du retailer, ZigZag relance l'envoi :

• Forbidden
• Unauthorized
• BadGateway
• BadRequest
• InternalServerError
• MethodNotAllowed
• RequestTimeout
• No response

Les tentatives d'envoi échouées sont relancées une fois par jour pour les échecs des 7 derniers jours. Ces tentatives continuent jusqu'à ce qu'une réponse positive soit reçue du système tiers.