Contrat d’interface
Un contrat d’interface décrit l’échange de données convenu. Structure, réponses et signification doivent être cohérentes pour les deux parties.
Un contrat d’interface est la description convenue de la manière dont les systèmes doivent échanger des données. Il comprend entrées attendues, réponses, erreurs et signification de ces retours. Une description lisible par machine peut en exprimer certaines parties ; les accords métier doivent aussi être compréhensibles.
Consigner la signification d’une réponse
Dans un portail client fictif, une transmission réussie confirme d’abord uniquement la réception par un composant intermédiaire. La création de la commande dans l’ERP exige un retour distinct. Si l’émetteur interprète la première réponse comme un traitement terminé, son utilisation ne correspond pas à l’accord.
Comparer description et implémentation
OpenAPI définit une description standardisée pour les API HTTP. Ces descriptions aident à comprendre les opérations et réponses disponibles. Elles ne prouvent pas, seules, qu’une application en cours d’exécution respecte le parcours convenu. Vérifiez des exemples adaptés et des cas d’erreur dans l’implémentation. Lors de modifications, il faut aussi préciser quels systèmes se fondent sur quel accord.
Sources
Termes associés
- JSON SchemaJSON Schema décrit la structure et les contraintes des données JSON. Un validateur vérifie ces règles ; leur respect ne prouve pas encore la justesse métier.
- Inbox transactionnelleUne inbox transactionnelle utilise des enregistrements durables de messages pour protéger le traitement local contre les livraisons en double.
- Acquittement de messageUn acquittement indique au courtier de messages qu’une livraison a été reçue ou traitée selon la règle convenue.
- Délai aléatoire avant réessaiLe jitter fait varier aléatoirement les délais pour étaler les nouvelles tentatives de plusieurs clients.
- Espace client de testUn espace client logiquement délimité d’une application multilocataire, configuré pour les vérifications.
- Rejeu de webhookLe rejeu de webhook renvoie une notification déjà envoyée. La reprise volontaire et les attaques par rejeu nécessitent des contrôles différents.
Articles sur le sujet
Interfaces & intégration avec ASES
ERP, CRM et boutique bien connectés