Passer au contenu principal

Transfert de données en temps réel via l'API

Comment transférer des données de Fonzip vers mon propre système ? Qu'est-ce qu'un déclencheur web ? Comment l'utiliser ?

Erdi avatar
Écrit par Erdi
Mis à jour hier

Grâce aux déclencheurs web, vous pouvez notifier vos propres serveurs des événements spécifiques qui se produisent dans Fonzip et enregistrer ces événements dans votre propre système.

Qu'est-ce qu'un déclencheur web ? Comment puis-je en créer un ?

Les déclencheurs web sont une fonctionnalité qui envoie des notifications à l'adresse de votre choix lorsqu'un événement se produit dans le système. Vous pouvez créer un déclencheur web en allant dans le menu de gauche Paramètres > Avancé > Déclencheurs Web, puis en cliquant sur Créer un déclencheur web.

Sur l'écran de création, entrez le nom du déclencheur et l'adresse à laquelle vous souhaitez que la requête soit envoyée. Sélectionnez les statuts que vous souhaitez recevoir et enregistrez.

Vous pouvez tester le déclencheur web pertinent depuis la section des opérations sur le côté droit.

Quel est le contenu d'un déclencheur web ?

Comme indiqué dans la section https://fonzip.com/api/v2/docs#operation/createWebhook, un JSON est envoyé à l'URL que vous avez spécifiée pour le déclencheur web.

{

"id": 0,

"webhook_id": 0,

"operation": 1,

"status": 0

}

  • id: Numéro d'enregistrement de l'objet concerné

  • webhook_id: ID de votre déclencheur web

  • operation: type d'opération ( 1: Don, 2: Cotisation, 3: Billet, 4: Formulaire, 5: E-carte, 6: Campagne de dons)

  • status: statut de l'opération (0: campagne créée, 3: réussi, 4: remboursement, 5: erreur)

Une requête de déclencheur web est arrivée, que dois-je faire ?

Une fois la requête du déclencheur web arrivée dans votre système, vous pouvez vous connecter via l'API avec le numéro d'enregistrement de l'opération concernée et la récupérer dans votre système.

Par exemple, si une requête arrive dans votre système lorsqu'un don est effectué, vous pouvez appeler les détails du don avec la fonction Obtenir les détails du don ( https://fonzip.com/api/v2/docs#operation/getDonationDetails ) et les enregistrer dans votre système.

Le déclencheur web n'est pas arrivé / Est arrivé mais une erreur s'est produite, que dois-je faire ?

Fonzip tente de déclencher une opération 3 fois et ne réessaye plus en cas d'échec. Pour prévenir d'éventuels problèmes, vous pouvez lister les opérations quotidiennes une fois par jour, comparer le nombre total d'opérations avec votre propre système et récupérer celles qui sont manquantes de la liste.

Par exemple, vous pouvez comparer le paramètre total de tous les dons du jour précédent listés avec la fonction Lister les dons https://fonzip.com/api/v2/docs#operation/getDonationList avec votre propre système. Lors de l'exécution de ces requêtes, n'oubliez pas de filtrer par fuseau horaire.

Avez-vous trouvé la réponse à votre question ?