Versions
L’API marchand et ses documents sont en version 1, et au sein de la v1 ils ne font que s’enrichir. Une intégration écrite pour la v1 continue de fonctionner.
Les chemins, noms de champs, codes d’erreur, noms d’en-têtes et exemples de code restent en anglais : ils font partie du contrat.
Ce qui peut changer au sein de la v1
- Un nouveau champ optionnel dans une réponse, une requête ou le document de commande.
- Une nouvelle route, un nouveau code d’erreur, un nouvel événement de webhook ou une nouvelle valeur dans une liste de valeurs autorisées.
- Un nouveau schéma de signature à côté de
v1=dansCutOptim-Signature; les récepteurs ignorent les schémas qu’ils ne connaissent pas.
Ce qui ne change jamais au sein de la v1
- Aucun champ ne disparaît, n’est renommé ni ne change de sens.
- Aucune route ne change de chemin, de clé ou de forme de réponse.
- Un code d’erreur garde sa signification.
Écrire un lecteur tolérant
Ignorez les champs que vous ne connaissez pas, traitez un code d’erreur inconnu d’après son statut HTTP, et acceptez avec un 2xx un type d’événement de webhook auquel vous n’êtes pas abonné. Le schemaVersion du document de commande et de chaque corps de webhook vaut 1.
Un changement incompatible
Un changement incompatible serait un nouveau document (order.v2) ou un nouveau chemin (/cfg/v2) à côté de la v1, jamais une réécriture de la v1. Il serait annoncé dans le Journal des modifications.
Il n’y a volontairement pas de bouton « essayer » ici : la clé secrète appartient à votre serveur, jamais à un navigateur. La boutique de démonstration montre l’intégration et la transmission de la commande de bout en bout.
Mentions légalesConditions du configurateur (EN) ·Accord de traitement des données (EN) ·Notice de confidentialité pour les acheteurs ·Licences tierces (EN)