Passer au contenu principal
Les pannes réseau arrivent. Lorsqu’une requête dépasse le délai d’attente, vous ne pouvez pas savoir si PapelShip a créé la commande. Un en-tête Idempotency-Key vous permet de réessayer l’appel à la Store API en toute sécurité.

Fonctionnement

Ajoutez un en-tête Idempotency-Key (255 caractères maximum) à une requête de création ou d’action. PapelShip conserve la première réponse pendant 24 heures. Une nouvelle tentative avec la même clé et le même corps reçoit cette réponse enregistrée, au lieu d’exécuter à nouveau la requête.

Points de terminaison compatibles

La clé fonctionne sur les points de terminaison de création et d’action de la Store API, notamment :
  • POST /invoices (créer une commande)
  • POST /invoices/{invoiceId}/papelpay (lancer le paiement par carte)
  • POST /invoices/{invoiceId}/complete et POST /invoices/{invoiceId}/refund
  • POST /orders/{invoiceId}/shipments
  • POST /products et POST /coupons

Bonnes pratiques

  • Générez une clé par commande, et non par requête. L’identifiant de votre propre commande convient très bien.
  • Enregistrez la clé avec votre commande afin que chaque nouvelle tentative la réutilise.
  • Ne réutilisez jamais une clé pour une autre commande ou un autre montant.