POST à votre serveur lorsqu’un événement se produit dans votre boutique, vous n’avez donc pas besoin d’interroger l’API en boucle.
Créez des points de terminaison dans Developers › Webhooks ou avec POST /webhooks.
Événements
GET /events/types renvoie la même liste.
Charge utile
Les montants des webhooks sont exprimés en unités majeures (
34.99), contrairement à l’API, qui utilise les unités mineures (3499).Vérifier la signature
Chaque requête comporte les en-têtes suivants :
La signature est
HMAC-SHA256(secret, "<t>.<raw body>") en hexadécimal. Le secret (whsec_...) s’affiche lorsque vous créez le point de terminaison. Calculez-la sur le corps brut, avant d’analyser le JSON, et rejetez les horodatages trop anciens.
Réponse et nouvelles tentatives
- Répondez avec n’importe quel statut
2xxdans un délai de 10 secondes. Effectuez les traitements lents après avoir répondu. - Les livraisons échouées sont réessayées après 1 minute, 5 minutes, 30 minutes, 2 heures, 6 heures et 12 heures (7 tentatives sur environ 21 heures).
- Un point de terminaison est désactivé après 40 échecs consécutifs sans aucun succès pendant 3 jours. Réactivez-le dans le tableau de bord ou avec
PATCH /webhooks/{id}etenabled: true. - Un même événement peut arriver plusieurs fois. Utilisez
PapelShip-Event-Idpour ne le traiter qu’une seule fois.
Gérer les points de terminaison avec l’API
secret de signature. Il n’est affiché qu’une seule fois ; stockez-le dans l’environnement de votre serveur.
Le renouvellement du secret reste dans le tableau de bord.