L’API AdminPulse et les webhooks vous permettent de connecter AdminPulse à d’autres logiciels. Une autre application peut ainsi récupérer des données dans AdminPulse, en ajouter ou exécuter des actions.
Vous pouvez développer une connexion standard utilisable par plusieurs cabinets AdminPulse ou une connexion destinée à un seul cabinet.
Dans cet article, vous découvrirez la différence entre ces deux possibilités, où trouver la documentation technique et comment créer une clé API.
Quel type de connexion souhaitez-vous créer ?
Créer une connexion standard en tant que fournisseur de logiciels
Vous êtes un fournisseur de logiciels et souhaitez proposer une connexion utilisable par plusieurs cabinets AdminPulse ? Consultez d’abord la documentation technique d’AdminPulse, puis envoyez une demande à notre équipe de support.
Dans votre demande, décrivez brièvement la connexion que vous souhaitez proposer et les cas d’utilisation concrets qu’elle prend en charge. Nous vous contacterons ensuite pour planifier un entretien préliminaire au cours duquel nous discuterons des possibilités et des prochaines étapes.
Une connexion destinée à un seul cabinet
Vous souhaitez connecter AdminPulse à un autre logiciel pour les besoins internes d’un seul cabinet ? Vérifiez d’abord dans Partenaires : aperçu des connexions avec AdminPulse s’il existe déjà une connexion standard.
Il n’existe pas de connexion standard adaptée ? Deux possibilités s’offrent alors à vous :
- Une connexion personnalisée via l’API et les webhooks : votre cabinet ou votre partenaire informatique développe une connexion sur mesure.
- Zapier : connectez AdminPulse à de nombreuses autres applications et configurez des workflows automatiques sans devoir programmer. Pour en savoir plus, consultez Zapier : automatisation de flux entre AdminPulse et d’autres logiciels.
Que sont une API et un webhook ?
Qu’est-ce qu’une API ?
Une API (Application Programming Interface) permet à deux applications de communiquer entre elles. Via l’API AdminPulse, une autre application peut, par exemple, récupérer les données des relations, ajouter des relations ou des enregistrements et modifier le statut des tâches.
Qu’est-ce qu’un webhook ?
Grâce à un webhook, AdminPulse informe automatiquement une autre application lorsqu’un changement se produit. L’application ne doit donc pas interroger régulièrement AdminPulse pour savoir si des données ont été ajoutées ou modifiées.
Un webhook peut, par exemple, transmettre un événement lorsqu’un document, un e-mail, une facture, un enregistrement, une relation, une tâche, une planification de tâche, une to-do ou un utilisateur est créé, modifié ou supprimé.
Vous configurez les webhooks via l’API, et non depuis un écran d’AdminPulse.
Où trouver la documentation technique ?
La documentation technique d’AdminPulse s’applique aussi bien aux connexions standard qu’aux intégrations propres à un cabinet. Vous y trouverez des informations sur l’authentification auprès de l’API, les possibilités offertes par l’API, la configuration des webhooks, la structure des messages envoyés et la manière de vérifier qu’un message provient bien d’AdminPulse.
Comment créer une clé API dans AdminPulse ?
Une clé API donne à une autre application accès à AdminPulse, dans les limites des droits que le cabinet attribue à cette clé.
👉 Traitez une clé API comme un mot de passe. Transmettez-la uniquement de manière sécurisée au fournisseur de logiciels ou au partenaire informatique qui gère la connexion.
- Allez dans Mon profil > Clés API. Vous pouvez également accéder directement à cette page via Clés API dans AdminPulse.
- Créez une nouvelle clé API et indiquez un Nom clair. Vous pourrez ainsi facilement identifier par la suite à quoi sert cette clé.
- Choisissez une Échéance adaptée à la durée prévue de la connexion.
-
Dans le champ Client, sélectionnez le logiciel pour lequel vous créez la clé API.
Le logiciel ne figure pas dans la liste et vous développez votre propre connexion ? Choisissez Intégration du bureau interne.
- Attribuez uniquement les droits nécessaires à la connexion. Déterminez avec votre partenaire informatique ou votre fournisseur de logiciels quels droits sont requis.