Pour commencer
Changements de l'API
Les changements qu'Abuna fait sans prévenir, et le préavis dont vous disposez pour les autres.
Cette page indique quels changements de l'API peuvent arriver à tout moment et lesquels sont annoncés, pour que le code que vous écrivez aujourd'hui continue de fonctionner. Certains changements arrivent à tout moment : le code écrit comme le décrit cette page continue de fonctionner malgré eux. Tous les autres changements sont annoncés 90 jours à l'avance.
Changements sans préavis
Ils peuvent survenir à tout moment. Écrivez votre code pour qu'il continue de fonctionner lorsqu'ils arrivent :
- Un nouveau champ dans une réponse, un objet, ou le
datad'un événement. Ignorez les champs que vous ne connaissez pas. - Un nouveau type d'événement. Répondez
2xxà un webhook dont vous ne gérez pas letype, et ignorez-le. - Un nouvel endpoint, ou un nouveau paramètre facultatif sur un endpoint existant.
- Une nouvelle valeur dans un champ qui liste ses valeurs, comme un nouveau
kindde message aux clients ou un nouveaucoded'erreur. Traitez une valeur inconnue comme la plus proche que vous connaissez, ou journalisez-la. - Une nouvelle paire dans l'en-tête
X-Abuna-Signature. Lisez les paires que vous connaissez et ignorez le reste. - Des identifiants et des curseurs d'une longueur ou d'une forme nouvelle. Traitez-les comme des chaînes opaques. Voyez les identifiants.
- Une nouvelle formulation dans la phrase
errord'une erreur. Branchez surcode, jamais sur la phrase.
Changements annoncés 90 jours à l'avance
Tout autre changement qui pourrait casser du code fonctionnel est annoncé au moins 90 jours avant de prendre effet. Cela comprend la suppression ou le renommage d'un endpoint, d'un champ ou d'un type d'événement, le changement du type ou du sens d'un champ, le passage d'un paramètre facultatif à obligatoire, et la modification de la signature des webhooks.
Pendant ces 90 jours, l'ancien comportement reste en place. L'entrée du journal des modifications indique ce qui change, la date d'entrée en vigueur, et ce qu'il faut modifier dans votre code.
Où suivre les changements
Chaque changement figure dans le journal des modifications avec sa date. Un changement annoncé y est inscrit le jour où les 90 jours commencent.
Étapes suivantes
- Journal des modificationsCe qui a changé dans l'API Abuna, du plus récent au plus ancien.
- Listes et filtresCe que renvoient les endpoints de liste, comment les paginer et les filtrer, et comment traiter les identifiants.
- Recevoir des webhooksRecevez les événements sur votre serveur et vérifiez qu'Abuna les a envoyés.