Webhooks: Intégration automatique

Créé: 07/02/2018
Dernière mise à jour: 07/02/2018
Nombre de vues pour le message: 74

VosFactures est un logiciel de facturation en ligne avec une API pratique vous permettant de connecter le logiciel avec une application externe. Notamment, vous pouvez utilisez des Webhooks pour une communication automatisée, afin d'informer par exemple votre site de chaque nouvelle facture créée. 

Définition

Une webhook, dans le cadre d'une interface de programmation API, est un mécanisme qui permet d'envoyer une information à une application tierce (ex: site internet) lorsqu'une action définie a eu lieu (ex: création d'un nouveau contact). L'utilisation des webhooks est destinée principalement aux développeurs et aux utilisateurs avancés. 

Utilité

L'utilisation de webhooks dans votre compte VosFactures permet au logiciel de facturation de notifier votre application externe q'un évènement de votre choix a eu lieu. Les informations étant envoyées automatiquement au moment où l'évènement se produit, et cela sans avoir à sonder l'interface API pour chercher les modifications, cela réduit la charge sur les serveurs. 
Par exemple, vous voulez informer votre site à chaque fois qu'un nouveau contact est créé, ou qu'une nouvelle facture est générée. 
 

Paramétrer les Webhooks

Depuis Paramètres > Paramètres du compte > Intégration > Webhooks, vous pouvez configurer une webhook comme suit: 

  • Type :  choisissez le type d'évènement qui doit déclencher l'envoi du webhook : création, modification, ou suppression d'un contact, produit, ou document. 

  • : indiquez l'URL à laquelle le webhook doit être envoyé. 

  • :  indiquez le code API de votre compte.

Puis sauvegardez. 

Lorsque l'événement défini est déclenché, le logiciel envoie une requête HTTP vers l'URL que vous avez indiquée. 

Exemple de Webhook envoyé: 

{
client_id: <ID unique du contact>
client: {<nom du contact>}
app_name 'vosfactures'
api_token <api token indiqué>
locale: I18n.locale (par exemple. 'fr')
}

 



Retour


Ajouter un commentaire