API & Webhooks
Avec l'API et les webhooks de Salonnare, vous connectez votre salon à d'autres logiciels : votre logiciel de comptabilité, votre propre site web, un service de newsletter ou un tableau de bord sur mesure. Pas besoin d'être développeur pour comprendre à quoi ils servent -- cette page l'explique tranquillement.
Cette fonctionnalité porte encore la mention Bientôt dans l'application : vous ne pouvez pas encore créer de clés API ni de webhooks. Si vous ouvrez Paramètres > API & Webhooks, vous ne voyez qu'un message indiquant que la fonctionnalité arrive. Cette page décrit son fonctionnement une fois qu'elle sera disponible.
Qu'est-ce qu'une API ?
Une API (Application Programming Interface) est un accord qui permet à deux programmes de communiquer entre eux. Là où vous cliquez sur un bouton dans l'application pour charger un rendez-vous, un autre programme peut demander les mêmes données via l'API -- automatiquement et sans intervention manuelle.
Exemples pratiques pour un salon :
- Votre logiciel de comptabilité récupère automatiquement votre chiffre d'affaires chaque nuit.
- Votre propre site web affiche vos prestations et vos prix, directement depuis Salonnare.
- Un partenaire d'intégration synchronise votre fichier clients.
L'accès à l'API passe par une clé API : un code secret qui prouve que la demande vient de vous. Traitez cette clé comme un mot de passe.
Créer une clé API
- Allez dans Paramètres -> API & Webhooks.
- Dans l'onglet Clés API, cliquez sur Nouvelle clé.
- Donnez à la clé un nom reconnaissable (par exemple "Comptabilité") et choisissez les droits : Lecture seule, Lecture + écriture ou Accès complet. Pour l'instant, une clé API ne peut que récupérer des données, quel que soit le niveau de droits choisi ; une clé en lecture seule ne pourra de toute façon jamais faire plus que ça.
- Copiez la clé immédiatement et conservez-la en lieu sûr. Pour des raisons de sécurité, Salonnare n'affiche la clé complète qu'une seule fois.
Vous pensez qu'une clé a fuité ? Supprimez-la aussitôt -- toute intégration utilisant cette clé s'arrête immédiatement.
Qu'est-ce qu'un webhook ?
Un webhook est l'inverse de l'API. Au lieu que vous récupériez des données, Salonnare envoie automatiquement un message à une adresse (URL) que vous avez indiquée dès qu'un événement se produit. L'autre logiciel n'a plus besoin de demander sans cesse "y a-t-il du nouveau ?" -- il reçoit un signal de lui-même.
Salonnare peut envoyer ces six événements :
booking.created-- un membre de l'équipe crée un rendez-vous dans l'applicationbooking.updated-- un membre de l'équipe modifie un rendez-vous dans l'application (y compris un changement de statut vers terminé ou absence)booking.cancelled-- un membre de l'équipe annule un rendez-vous dans l'applicationpayment.received-- un membre de l'équipe finalise un encaissement en caisseclient.created-- un membre de l'équipe crée un client dans l'applicationclient.updated-- un membre de l'équipe modifie les données d'un client dans l'application
Chaque événement provient d'une action réalisée dans l'application. Une réservation en ligne via votre page de réservation ou Google, un client qui annule lui-même, une liste d'attente convertie, une série récurrente, une cure et un client qui se crée lui-même sur la page de réservation n'envoient (pas encore) de notification. Signalez-le à votre partenaire d'intégration : il peut rattraper les rendez-vous manqués en récupérant régulièrement la liste des rendez-vous.
Configurer un webhook
- Allez dans Paramètres -> API & Webhooks et ouvrez l'onglet Webhooks.
- Cliquez sur Nouveau webhook.
- Saisissez l'URL vers laquelle Salonnare enverra les notifications (votre partenaire d'intégration ou développeur vous la fournit).
- Choisissez les événements auxquels vous voulez réagir.
- Enregistrez. Vous pouvez ensuite consulter les journaux d'envoi pour vérifier que les notifications arrivent correctement.
Le secret que Salonnare utilise pour signer les messages s'affiche dès que vous enregistrez le webhook -- conservez-le en lieu sûr immédiatement, comme une clé API, car Salonnare ne l'affichera plus ensuite. Si vous le perdez, cliquez sur l'icône d'actualisation à côté du webhook (Demander un nouveau secret) ; un nouveau secret s'affiche alors une seule fois. L'ancien secret cesse alors de fonctionner, il faut donc aussi mettre à jour le côté récepteur.
Chaque notification de webhook porte une signature qui permet au destinataire de vérifier que le message vient bien de Salonnare.
Travailler en sécurité
- Ne partagez jamais vos clés API publiquement (ni par e-mail, ni dans des captures d'écran, ni dans du code publié en ligne).
- Ne donnez à une intégration que les droits dont elle a vraiment besoin -- choisissez la lecture seule lorsque c'est possible.
- Supprimez les clés et webhooks que vous n'utilisez plus.
Comme Salonnare traite vos données dans l'UE et que vous décidez vous-même quelles intégrations ont accès, vous gardez le contrôle total de vos données. Besoin d'aide pour une intégration ? N'hésitez pas à nous contacter via la page d'assistance.
Vous êtes développeur et cherchez les détails techniques (authentification, endpoints, champs, codes d'erreur, vérification de signature) ? Consultez la Référence API -- cette page est en anglais, car elle s'adresse aux développeurs.