Évolution de l'API¶
Introduction¶
Cette page décrit comment l'API VoidSign évolue au fil du temps et comment vous pouvez rester informé des améliorations. Notre objectif est de donner aux intégrateurs la confiance que le code existant continuera de fonctionner à mesure que la plateforme se développe.
Politique d'évolution de l'API¶
L'API VoidSign évolue de manière non cassante pour les intégrations existantes. Les endpoints, les champs et les comportements sur lesquels vous vous appuyez aujourd'hui resteront stables. Tous les changements sont additifs : nous étendons la surface de l'API plutôt que de modifier ce qui existe déjà.
Vous n'avez pas besoin de mettre à jour votre intégration à chaque amélioration que nous publions. Votre code existant continuera de fonctionner tel quel.
Changements non cassants¶
Les types de changements suivants sont considérés comme non cassants et peuvent être introduits à tout moment sans préavis :
- Nouveaux endpoints : ressources ou actions supplémentaires ajoutées à l'API.
- Nouveaux paramètres de requête optionnels : champs optionnels supplémentaires acceptés dans les corps de requête.
- Nouveaux champs dans les réponses : champs supplémentaires inclus dans les objets de réponse existants.
- Nouveaux types d'événements webhook : événements supplémentaires envoyés à votre URL de webhook.
- Nouveaux codes d'erreur : codes d'erreur supplémentaires pour de nouveaux scénarios d'échec.
- Changements d'ordre des champs : l'ordre des champs dans les réponses JSON peut changer.
Recommandation pour l'analyse syntaxique
Votre parser JSON doit ignorer les champs inconnus plutôt que de les traiter comme des erreurs. Cela garantit que votre intégration gère correctement les nouveaux champs de réponse au fur et à mesure que nous les ajoutons.
Rester informé¶
Pour recevoir des communications sur les mises à jour de l'API, les améliorations et les fonctionnalités à venir, inscrivez-vous directement depuis le tableau de bord VoidSign. Connectez-vous, accédez à la section API, ouvrez l'onglet Présentation, et cliquez sur le bouton « S'inscrire à la newsletter ».
Restez informé
Connectez-vous à votre tableau de bord VoidSign, accédez à API → Présentation, et cliquez sur le bouton d'inscription. C'est le meilleur moyen de rester informé des nouvelles fonctionnalités dès leur publication.