Gestion des versions

La version de la Partner API est indiquée dans l'URL. La version actuelle est :

https://partner-api.performancehub.co/partner/v1/

Politique de modification

Performance Hub s'efforce, dans la mesure du possible, d'apporter des modifications additives et rétrocompatibles.

Exemples de modifications rétrocompatibles :

• L'ajout d'un nouveau champ facultatif à une requête.
• L'ajout d'un nouveau champ à une réponse.
• L'ajout d'un nouvel endpoint.
• L'ajout d'une nouvelle valeur d'énumération lorsque les clients sont censés gérer les valeurs inconnues.
• L'amélioration des messages de validation sans modifier le contrat des codes de statut.

access_time_windows et access_time_windows_revision sont des champs additifs des requêtes Member. Les clients existants qui les omettent conservent tel quel l'instantané des Access Time Windows stocké. Cette règle d'omission préserve la compatibilité des upserts partiels ; l'omission n'équivaut pas à l'envoi d'un tableau vide.

Exemples de modifications non rétrocompatibles :

• La suppression ou le renommage d'un champ.
• La modification du type d'un champ.
• Le passage d'un champ de requête facultatif à obligatoire.
• La suppression d'un endpoint.
• La modification de la signification d'un code de statut existant ou d'un reason propre à un domaine.

Obsolescences

Lorsqu'une modification non rétrocompatible est nécessaire, Performance Hub évite, dans la mesure du possible, de modifier la version existante en place. Nous introduisons plutôt une nouvelle version ou un chemin de migration et communiquons la modification aux partenaires concernés.

Les avis d'obsolescence peuvent prendre la forme de :

• Une entrée dans le journal des modifications.
• Une communication directe aux partenaires.
• Des notes dans la Partner Console.
• Des conseils de migration dans la documentation.

Recommandations pour les clients

Concevez des clients qui tolèrent les modifications additives :

• Ignorez les champs de réponse que vous n'utilisez pas.
• Traitez les valeurs d'énumération inconnues comme non prises en charge au lieu de provoquer un plantage.
• Évitez les contrôles d'égalité stricts sur les réponses.
• Journalisez les valeurs non reconnues afin de pouvoir mettre à jour votre intégration de façon délibérée.

Pour les partitions Member révisionnées telles que les Access Time Windows, conservez la révision soumise et la charge utile normalisée jusqu'à ce que le résultat soit connu. Réutiliser une révision pour un contenu modifié constitue un conflit, tandis que rejouer le même contenu est idempotent. Consultez Access Time Windows.

Spécifications OpenAPI

Utilisez les spécifications OpenAPI publiées pour générer des clients, valider les requêtes et suivre l'évolution de la structure de l'API au fil du temps.

Consultez Spécifications OpenAPI.