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 livraisons récentes de webhooks et inspecter l’utilisation de l’API pour votre organisation.
Le portail remplace l’ancien tableau de bord API pour les nouveaux flux 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.
Access
Allez sur developer.legalesign.com. Connectez-vous avec votre compte Legalesign. Vous pouvez être connecté 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.
API Keys
La section API Keys 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 pourra plus être affichée.
Les nouvelles clés utilisent le format de clé API entreprise et sont envoyées en tant que jeton porteur :
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. Migrer les nouvelles intégrations vers les nouvelles clés API et révoquer les clés héritées lorsqu’elles ne sont plus utilisées.
Environment
La section Environment affiche les identifiants d’organisation 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 REST API qui agissent au sein 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 lorsque les deux sont disponibles.
Si votre utilisateur REST API est en mode sandbox, la section Environment affiche votre limite actuelle de débit (100 appels par heure).
Webhooks
La section Webhooks vous permet de créer, modifier, 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 récentes de livraison des webhooks. Utilisez la vue de 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 depuis cette page.
Pour une configuration automatisée, la configuration des webhooks peut également être gérée via l’API. Consultez le guide des webhooks pour les détails d’intégration.
Usage
La section Usage résume l’activité API récente 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 principales opérations.
- Le nombre de requêtes autorisées et refusées.
- L’activité des requêtes dans le temps.
C’est le premier endroit à vérifier après la création d’une clé et la réalisation d’une requête de test. Cela aide à confirmer que la clé est utilisée et si les requêtes sont acceptées ou refusées.
Organisation Admin
Les administrateurs d’organisation peuvent voir une vue de gestion plus large pour leur organisation.
Selon vos permissions, cette section peut inclure :
- Les clés API au niveau organisation.
- Les clés actives et révoquées.
- L’utilisation des clés organisationnelles.
- Les événements d’audit des clés API.
- Les webhooks de l’organisation.
Utilisez cette vue pour examiner les accès, révoquer les clés appartenant aux utilisateurs de l’organisation et auditer les récents changements du cycle de vie des clés API.
