GlossaireAPI
Une API définit une manière structurée d’échanger des données ou de demander une opération entre systèmes. Dans un programme, elle peut relier les achats, l’éligibilité, les points ou les commandes. Le contrat, l’authentification, les erreurs, les limites et les reprises doivent être documentés pour rendre l’intégration exploitable.
Un exemple concret
Une API peut recevoir une commande validée et retourner son identifiant de traitement. Un identifiant unique permet d’éviter de créditer deux fois la même opération.
Le point de vigilance
Prévoir uniquement le cas nominal ne suffit pas. Documentez authentification, doublons, erreurs, reprises et limites de fréquence.
Préparer un contrat exploitable par les deux équipes
Pour chaque échange, fournissez un exemple accepté, un exemple refusé, les champs obligatoires et les règles de reprise. Définissez un identifiant de corrélation pour retrouver une opération entre systèmes. Testez une interruption après traitement mais avant réception de la réponse : la reprise doit retrouver le résultat sans créer un second crédit. Prévoyez aussi le suivi des rejets et la compatibilité entre versions.
Les questions à poser à votre équipe
- Peut-on déterminer si une opération a été traitée après une coupure ?
- Les erreurs temporaires et les données invalides sont-elles traitées différemment ?
Livres blancs