Portail développeur
Le Portail Développeur Legalesign est l’endroit où vous pouvez gérer votre accès API et superviser votre organisation.
Utilisez-le pour créer et révoquer des clés API, copier les identifiants nécessaires à votre intégration, gérer les points de terminaison webhook, consulter les dernières livraisons webhook, et inspecter l’utilisation de l’API pour votre organisation.
Le portail remplace l’ancien tableau de bord API pour les nouveaux workflows de gestion des clés API. Les clés API REST héritées existantes continuent de fonctionner pour les intégrations existantes, mais les nouvelles intégrations doivent utiliser le portail et le nouveau format de clé API.
Accès
Allez sur developer.legalesign.com. Connectez-vous avec votre compte Legalesign. Vous pouvez vous connecter automatiquement si vous avez une session active sur l’application web.
Votre compte doit être approuvé pour le développement API. Si le portail indique que la gestion des clés API n’est pas activée pour votre utilisateur, créez un ticket de support et demandez la vérification de l’accès API.
Clés API
La section Clés API vous permet de créer et révoquer des clés API pour une organisation.
Lorsque vous créez une clé, choisissez :
- Un nom de clé, généralement l’intégration ou l’environnement qui l’utilisera.
- L’interface API : REST, GraphQL, ou les deux.
- Une période d’expiration optionnelle.
La clé API en clair est affichée une seule fois, immédiatement après la création. Copiez-la avant de quitter la page car elle ne peut pas être affichée à nouveau.
Les nouvelles clés utilisent le format clé API entreprise et sont envoyées sous forme de jeton bearer :
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Les clés REST héritées sont affichées séparément lorsqu’elles existent. Elles sont supportées uniquement pour les intégrations REST existantes. Faites migrer les nouvelles intégrations vers les nouvelles clés API et révoquez les clés héritées lorsqu’elles ne sont plus utilisées.
Environnement
La section Environnement affiche les identifiants organisationnels et d’équipe disponibles pour votre compte.
Utilisez cette section lorsqu’une requête API nécessite un contexte d’organisation ou d’équipe. En particulier, les requêtes API REST qui agissent à l’intérieur d’une organisation doivent inclure l’en-tête organisation :
X-Organisation: <organisation-id>
Le portail affiche les identifiants GraphQL et REST côte à côte lorsqu’ils sont tous deux disponibles.
Si votre utilisateur API REST est en mode sandbox, la section Environnement affiche également les adresses email des destinataires sandbox approuvés. Le mode sandbox restreint l’envoi de documents REST à ces adresses.
Webhooks
La section Webhooks vous permet de créer, éditer, désactiver, et supprimer des points de terminaison webhook.
Pour chaque webhook, choisissez :
- L’URL du point de terminaison.
- Le type d’événement.
- La portée du groupe, ou tous les groupes.
- Si le webhook est activé.
Le portail affiche également les tentatives de livraison webhook récentes. Utilisez la vue journal pour inspecter les charges utiles des événements, le statut des livraisons, et les échecs récents.
Pour faciliter le développement des webhooks, vous pouvez aussi pousser manuellement des événements webhook sur cette page.
Pour une configuration automatisée, la configuration des webhooks peut également être gérée via l’API. Consultez le guide webhooks pour les détails d’intégration.
Utilisation
La section Utilisation résume l’activité récente de l’API pour l’organisation sélectionnée.
Utilisez-la pour vérifier :
- Le volume total des requêtes.
- Quelles clés ont été utilisées.
- Les opérations principales.
- Le nombre de requêtes autorisées et refusées.
- L’activité des requêtes au fil du temps.
C’est le premier endroit à vérifier après la création d’une clé et l’exécution d’une requête test. Cela permet de confirmer que la clé est utilisée et si les requêtes sont acceptées ou refusées.
Administration Organisation
Les administrateurs organisationnels peuvent voir une vue de gestion plus large pour leur organisation.
Selon vos permissions, cette section peut inclure :
- Les clés API au niveau organisationnel.
- Les clés actives et révoquées.
- L’utilisation des clés de l’organisation.
- Les événements d’audit des clés API.
- Les webhooks de l’organisation.
Utilisez cette vue pour revoir les accès, révoquer les clés détenues par les utilisateurs de l’organisation, et auditer les récents changements dans le cycle de vie des clés API.
