Sat Sep 26 2020
...
Les Webhooks arrivent sur FastComments
! Cet Article Contient du Jargon Technique
Quoi de Neuf
Avec FastComments, il est désormais possible d'invoquer un point de terminaison API chaque fois qu'un commentaire est ajouté, mis à jour ou supprimé de notre système.
Nous y parvenons grâce à des webhooks asynchrones via HTTP/HTTPS.
Comment l'Utiliser
Tout d'abord, accédez à l'administration des Webhooks. Ceci est accessible via Gérer les données -> Webhooks.
De là, vous pouvez spécifier des points de terminaison pour chaque type d'événement de commentaire.
Pour chaque type d'événement, assurez-vous de cliquer sur Envoyer un Payload de Test pour vous assurer que votre intégration est correctement configurée. Consultez la section suivante, "Test", pour plus de détails.
Test
Dans l'administration des Webhooks, il y a des boutons "Envoyer un Payload de Test" pour chaque type d'événement (Créer, Mettre à jour, Supprimer). Les événements Créer et Mettre à jour envoient un objet WebhookComment fictif, tandis que le test de Suppression enverra un corps de requête fictif contenant uniquement un ID.
Le test effectuera deux appels pour vérifier le code de réponse pour les scénarios "heureux" (clé API correcte) et "triste" (clé API invalide).
Lorsque le test envoie une clé API invalide, vous devez retourner un code de statut 401 pour que le test réussisse complètement. Si vous ne vérifiez pas correctement la valeur du token, vous verrez une erreur comme :
La Structure de l'Objet Commentaire
La Structure de l'Événement "Créer"
Le corps de la requête de l'événement "créer" est un objet WebhookComment.
La Structure de l'Événement "Mettre à Jour"
Le corps de la requête de l'événement "mettre à jour" est un objet WebhookComment.
La Structure de l'Événement "Supprimer"
Le corps de la requête de l'événement "supprimer" est un objet WebhookComment, mais contenant uniquement l'id.
Pourquoi Créer et Mettre à Jour utilisent-elles toutes les deux HTTP PUT et non POST ?
Puisque toutes nos requêtes contiennent un ID, répéter la même requête de Création ou de Mise à jour ne devrait pas créer de nouveaux objets de votre côté. Cela signifie que ces appels sont idempotents et doivent être des événements PUT selon la spécification HTTP.
Comment Cela Fonctionne
Tous les changements apportés à l'objet Commentaire dans le système déclenchent un événement qui finit dans une file d'attente. Vous pouvez surveiller cette file d'attente dans l'administration des Webhooks au cas où votre API tomberait en panne. Si une requête à votre API échoue, nous la remettrons dans la file d'attente selon un calendrier. Ce calendrier est de 1 Minute * le nombre de tentatives. Si l'appel échoue une fois, il essaiera à nouveau dans une minute. S'il échoue deux fois, il attendra ensuite deux minutes, et ainsi de suite. Cela permet d'éviter de surcharger votre API si elle rencontre des problèmes liés à la charge.
Sécurité & Token API
Dans l'en-tête de la requête, nous transmettrons votre Secret API dans le paramètre appelé "token".
Si vous ne vérifiez pas correctement ce paramètre, votre intégration ne sera pas marquée comme Vérifiée. C'est une mesure de sécurité pour garantir que toutes les intégrations avec FastComments sont sécurisées.
En Conclusion
Nous espérons que vous trouvez l'intégration de Webhook FastComments facile à comprendre et rapide à configurer.
Si vous avez d'autres questions, n'hésitez pas à contacter la page de support client.
À bientôt !