Gestion des versions

Ce guide explique comment l'API Merchant gère le contrôle de version, les versions et le cycle de vie de ses différentes versions.

Schéma de gestion des versions

L'API Merchant utilise une stratégie de gestion des versions au niveau des sous-API. Cela signifie que chaque API, par exemple Products dans l'API Merchant, aura son propre cycle de vie de version.

Format et présentation des versions

  • Versions stables des sous-API : si une sous-API est dans une version stable, toutes ses méthodes le sont également. Une version stable de sous-API est représentée par vX (par exemple, v1, v2). Il s'agit de versions majeures prêtes pour la production.

  • Versions alpha des sous-API : si une sous-API est en version alpha, toutes ses méthodes le sont également. Une sous-version alpha de l'API est représentée par vXalpha (par exemple, v1alpha, v2alpha). Elles contiennent des fonctionnalités expérimentales en accès anticipé destinées aux tests et à l'itération rapide. Les versions alpha ne sont pas stables, n'ont pas de durée de vie définie et peuvent être modifiées ou arrêtées avec un préavis de 30 jours.

Modifications apportées à la version

  • Incréments de version majeure (par exemple, de v1 à v2) : ils signalent des modifications destructives et incompatibles avec les versions antérieures, qui nécessitent une action de la part du développeur. Seules les modifications importantes apportées aux sous-API stables auront un nouveau numéro de version. Par exemple, de la version v1 à la version v2.

  • Modifications mineures : les ajouts ou les corrections rétrocompatibles sont présentés comme des modifications apportées à la version majeure existante. Ces modifications seront détaillées dans les notes de version de cette version majeure. Les ajouts non destructifs à une sous-API seront publiés dans le canal alpha de la dernière version stable ou directement dans la dernière version stable.

Règles d'arrêt définitif

Nous abandonnons régulièrement les anciennes versions des sous-API Merchant. Nous nous engageons à respecter un délai de 12 mois pour l'arrêt des versions majeures stables (vX), à compter de l'annonce officielle de l'arrêt.

Par exemple, si nous abandonnons la version 1 de la sous-API Products le 15 janvier 2026, elle sera supprimée au plus tôt le 15 janvier 2027. Au-delà de cette date, l'ancienne version de la sous-API ne sera plus disponible.

Version de la sous-API et état du cycle de vie

Le tableau suivant répertorie les dernières versions de chaque sous-API de l'API Merchant :

Sous-API Versions État
Comptes v1
v1beta
Actif
Sera arrêté le 28 février 2026
Conversions v1
v1beta
Actif
Sera arrêté le 28 février 2026
Sources de données v1
v1beta
Active
Arrêt prévu le 28 février 2026
Stocks v1
v1beta
Actif
Sera arrêté le 28 février 2026
Résolution des problèmes v1
v1beta
Actif
Sera arrêté le 28 février 2026
Partenariat pour les flux en magasin v1
v1beta
Actif
Sera arrêté le 28 février 2026
Notifications v1
v1beta
Actif
Sera arrêté le 28 février 2026
Suivi des commandes v1
v1beta
Actif
Sera arrêté le 28 février 2026
Produits v1
v1beta
Actif
Sera arrêté le 28 février 2026
Product Studio v1alpha Actif
Promotions v1
v1beta
Actif
Sera arrêté le 28 février 2026
Quota v1
v1beta
Actif
Sera arrêté le 28 février 2026
Création de rapports v1
v1beta
Actif
Sera arrêté le 28 février 2026
Avis v1alpha
v1 bêta
Actif
Sera arrêté le 28 février 2026

Bonnes pratiques

  • Consultez régulièrement les notes de version et les dernières mises à jour pour découvrir les nouvelles versions, les mises à jour majeures, les améliorations et les annonces concernant les lancements et les abandons de sous-API.
  • Si une sous-API comporte au moins deux versions stables, nous vous suggérons d'utiliser la dernière version à tout moment.
  • Concevez votre application pour qu'elle gère correctement les différentes erreurs de sous-API, y compris les problèmes de réseau, les limites de débit et les nouveaux codes ou messages d'erreur qui peuvent être introduits avec les nouvelles versions de sous-API.
  • N'attendez pas qu'une sous-version de l'API soit sur le point d'être abandonnée pour commencer à planifier votre mise à niveau. Commencez à évaluer et à tester les nouvelles versions dès qu'elles sont disponibles.
  • Pour toute demande de fonctionnalité ou question concernant la feuille de route d'une sous-API, contactez-nous. Pour savoir comment contacter l'équipe de l'API Merchant afin d'obtenir une assistance technique, consultez Obtenir de l'aide concernant l'API Merchant.