Sur cette page
Avant de commencer
Il vous faut un accès Open API pour qu'un appel fonctionne : un client validé par e-tailize, ainsi que la clé et le secret qui lui appartiennent.
La version 1 de l'API se trouve sous https://app.e-tailize.eu/public/api/v1 et compte 17
endpoints répartis en trois domaines : Auth, Connections et Products. La liste complète, avec
les champs de chaque appel, figure sur la page Swagger à l'adresse
https://app.e-tailize.eu/swagger/index.html.
L'API ne parle que JSON, et elle vous renvoie une erreur en application/problem+json.
Étapes
- Choisissez le domaine auquel votre appel appartient. Auth demande l'accès et génère, valide et révoque une clé. Connections contient le catalogue de ce que vous pouvez connecter, vos connexions, les commandes, les envois et les destinations de transmission. Products contient vos produits et leur stock.
- Définissez les en-têtes d'identification de ce domaine :
X-Api-ClientIdsur Auth, etX-Api-KeyplusX-Api-Secretsur Connections et Products, où les deux sont obligatoires. La première demande d'accès fait exception : elle ne porte aucun en-tête. - Envoyez
Accept: */*à chaque appel. Un client qui accepte uniquementapplication/jsonreçoit un 406 au lieu de l'erreur qu'il doit lire. - Appelez
GET /Connections/definitionsavant de créer une connexion. Cet appel renvoie les champs que demande chaque marketplace, et les noms dansconnectionFieldssont sensibles à la casse : copiez ces noms à l'identique. - Faites correspondre vos propres SKU aux identifiants produits d'e-tailize avec
GET /Products. La réponse est un objet paginé, donc vous parcourez le résultat page par page. - Mettez à jour un niveau de stock avec
PUT /Products/{id}/stocket un corps de requête qui contient le nouveau stock, par exemple 25 pièces. Lisezsucceededdans la réponse, cardatavaut toujours false, même quand l'appel réussit. - Maintenez chaque route dans son propre budget : Auth et Connections 10 requêtes par
60 secondes,
GET /Products30 par 60 secondes,PUT /Products/{id}/stock25 par 10 secondes. Le décompte se fait par route, par adresse IP et par clé, et il ne se vide pas progressivement : chaque appel relance le compteur de cette période. L'en-têteRetry-Afterindique combien de temps cette période doit encore durer. - Attendez la fin de toute la période quand un appel répond 429 avec le titre "Too many
requests." et, sous
errors.general, le message "Rate limit exceeded. Try again in 60 seconds.", où le nombre correspond à la période de cette route. Attendez le nombre de secondes qu'indique l'en-têteRetry-After, un simple nombre de secondes et le seul en-tête qu'ajoute le limiteur. Réessayer plus tôt ne fait que relancer le compteur.
Ce qui se passe ensuite
Ce que vous envoyez, ce sont des données normales de la plateforme. Une connexion que vous
créez apparaît sur la page "API connections" comme n'importe
quelle autre, et une mise à jour du stock suit les règles de transmission de cette
connexion, que vous pouvez relire avec GET /Connections/mutation-propagation-targets.
Ces règles déterminent le sens : le stock va de vous vers la marketplace, les commandes
viennent de la marketplace vers vous, et le suivi des colis part par connexion, ou par envoi
avec POST /Connections/{id}/shipment.
Problèmes fréquents
Un appel sans en-tête de clé répond 400, et non 401. Le titre est "One or more validation
errors occurred." et errors.general indique le problème : "X-Api-Key header is missing."
pour une clé manquante, "X-Api-Secret header is missing." pour un secret vide, et "Invalid
X-Api-Key header value." pour une clé qui n'est pas un GUID. Le message se trouve toujours
sous errors.general, jamais dans un champ detail.
Un 401 signifie que l'en-tête est présent et bien formé, mais pas accepté : le client n'est pas encore validé, la clé ou le secret est erroné, ou la clé a expiré.
Un identifiant de connexion qui ne vous appartient pas répond 404, comme un identifiant qui n'existe pas : la réponse ne confirme donc jamais quels identifiants existent.
Un POST /Connections qui échoue à la validation, par exemple à cause d'un nom de connexion
en double, peut revenir en 500. Lisez le message dans ce corps de réponse : il indique la
vraie cause.
Questions fréquentes
Où trouver chaque endpoint et ses champs ?
Sur la page Swagger à l'adresse https://app.e-tailize.eu/swagger/index.html, avec les
paramètres et les réponses des 17 endpoints. Vérifiez une vraie réponse avant de vous fier
à la forme d'un corps d'erreur, pour que votre client suive le comportement réel.
Je peux avoir deux clés API en même temps ?
Non. La génération refuse une deuxième clé active pour le même utilisateur. Pour renouveler la clé, vous révoquez d'abord celle que vous avez, puis vous en générez une nouvelle.
Un identifiant de commande est unique ?
Seulement au sein d'une marketplace. Deux marketplaces peuvent vous transmettre le même identifiant de commande : identifiez donc vos propres enregistrements par la définition de connexion associée à l'identifiant de commande, jamais par l'identifiant seul.
Articles liés
Cet article vous a aidé ?