Introduction
Cette fonctionnalité vous permet de générer une clé d'API technique pour gérer votre cabinet via nos APIs d'administration.
Nos APIs sont conçues pour vous permettre d’automatiser la gestion de vos utilisateurs et dossiers clients, vous offrant ainsi un gain de temps et une plus grande flexibilité dans l'administration de votre activité.
Pour commencer à utiliser nos APIs, il vous suffit de générer vos informations d’identification. Vous pourrez ensuite vous authentifier via le protocole OAuth2, garantissant ainsi une sécurité optimale lors de l’exploitation de nos APIs.
Pourquoi générer une clé d'API ?
Générer une clé d'API vous offre de nombreux avantages pour la gestion de votre cabinet :
Automatisation des tâches : Automatisez les tâches administratives répétitives et chronophages, comme la création et la gestion des utilisateurs, la mise à jour des informations clients, la gestion des accès, etc. Cela vous permet de gagner un temps précieux et de réduire les erreurs humaines.
Intégration avec vos outils : Connectez nos APIs avec vos propres outils et systèmes (CRM, logiciels de gestion, etc.) pour créer des flux de travail personnalisés et optimiser votre organisation. Vous pouvez ainsi centraliser vos données et vos processus pour une meilleure efficacité.
Flexibilité et contrôle : Développez vos propres applications ou scripts pour interagir avec nos services de manière personnalisée. Vous avez un contrôle total sur la façon dont vous utilisez nos APIs pour répondre à vos besoins spécifiques.
Amélioration de la productivité : En automatisant les tâches et en intégrant vos outils, vous améliorez la productivité de votre équipe et vous pouvez vous concentrer sur des activités à plus forte valeur ajoutée, comme le conseil et l'accompagnement de vos clients.
Générer une clé d'API
Accéder à la génération de la clé d'API
⚠️ Pour accéder à cette interface il faut être Administrateur du cabinet
Allez sur le service Admin
Dans le menu latéral, allez sur "Gestion du cabinet", cliquez sur Paramètres
Cliquez sur Authentification API
Générer la clé
La génération d'une clé d'API vous permet d'obtenir les informations d'identification nécessaires pour utiliser nos APIs d'administration.
Pour générer une clé d'API, dans le cadre de son initialisation :
Dans la section Authentification d'API, cliquez sur le bouton "Générer les informations d'identification".
Le système générera les informations suivantes :
ID Client : Identifiant unique de votre application.
Secret Client : Mot de passe de votre application, à conserver en lieu sûr.
Jeton d'accès : Jeton initial pour accéder aux APIs
Jeton d'actualisation : Jeton utilisé pour obtenir de nouveaux jetons d'accès.
Partage du jeton d'accès : Ces informations (ID Client, Secret Client, Jeton d'accès et Jeton d'actualisation) vous permettront d'obtenir l'accès nécessaire pour utiliser les APIs d'administration.
Actualiser la clé
L'actualisation de la clé d'API permet d'obtenir de nouveaux jetons d'accès de manière autonome, sans avoir à régénérer une nouvelle clé d'API complète.
Pour actualiser une clé d'API :
Dans la section Authentification d'API, cliquez sur le bouton "Actualiser".
Une fenêtre s'affichera afin de récupérer les nouveaux jetons pour partage
Supprimer la clé
La suppression d'une clé d'API invalide toutes les informations d'identification associées (ID Client, Secret Client, Jeton d'accès et Jeton d'actualisation). Cette action doit être effectuée avec précaution.
Pour supprimer une clé d'API :
Dans la section Authentification d'API, cliquez sur le bouton "Supprimer".
Une fenêtre s'affichera afin confirmer la suppression
⚠️ Après la suppression d'une clé d'API, toutes les applications ou intégrations qui l'utilisaient ne pourront plus accéder à nos APIs d'administration tant que vous n'aurez pas généré une nouvelle clé et mis à jour vos informations d'identification.