Aller au contenu

Clé d’idempotence

Une clé d’idempotence identifie les répétitions d’une même requête. Son effet dépend du périmètre, de la conservation et des règles de l’API.

Également appeléIdempotency Key
Interfaces & intégration

Une clé d’idempotence est un identifiant choisi par le client qui permet à un service de reconnaître les répétitions d’une même requête. L’objectif est d’éviter de reproduire, lors d’une nouvelle tentative, une action métier déjà exécutée. Le contrat de l’API en définit l’effet précis.

Réexaminer une requête à l’issue incertaine

Dans un portail fictif, la connexion est coupée après une requête de création de commande. On ignore si l’ERP a déjà créé la commande. Si le service prend en charge cette protection, le portail utilise la même clé pour une nouvelle tentative appropriée. Une nouvelle clé pourrait déclencher une création supplémentaire.

Respecter les règles de l’API

Stripe décrit des règles d’idempotence différentes pour les API v1 et v2. L’en-tête Idempotency-Key est un exemple propre à ce fournisseur. Vérifiez le périmètre, la conservation et le traitement des données de requête modifiées. Une même clé n’autorise pas n’importe quel nouveau contenu et ne prouve pas, à elle seule, que le traitement est terminé.

Sources

Articles sur le sujet

Interfaces & intégration avec ASES

ERP, CRM et boutique bien connectés