API GraphQL Legalesign
Legalesign propose deux API pour l’intégration de signatures électroniques :
- REST API - Démarrage rapide, format traditionnel
- GraphQL API - Puissance totale, plus flexible
Ce guide se concentre sur GraphQL. Vous aurez besoin de connaissances en JSON et d’une expérience de base en requêtes web.
Pourquoi choisir GraphQL ?
REST est fiable, familier et là pour durer. GraphQL vous offre une autre façon de penser la récupération et la structuration des données. Chez Legalesign, GraphQL est l’API de premier ordre — chaque partie de la plateforme est accessible via elle.
| REST | GraphQL | |
|---|---|---|
| Points de terminaison | Multiples (/users, /contracts, etc.) | Unique (/graphql) |
| Récupération de données | Fixe par point de terminaison | Requêtes définies par le client |
| Sur-/sous-récupération | Courante | Réduite |
| Gestion des versions | Versionnée (/v1/, /v2/) | Sans version — les nouveaux champs ne cassent pas les requêtes existantes |
| Authentification | Clé API | OAuth 2.0 ou clé API (même sous-ensemble supporté) |
GraphQL vous donne un accès complet aux fonctionnalités de Legalesign :
- Ne demandez que les données dont vous avez besoin
- Point de terminaison unique pour tout
- Même puissance que l’application web
Développeurs TypeScript/JavaScript
Pensez au SDK TS/JS pour les cas d’usage courants, mais apprendre GraphQL vous donne un accès complet à la plateforme. Comparez SDK vs GraphQL.
Essayez GraphQL dès maintenant
Commencez avec le GraphQL Explorer (compte actif requis).
L’Explorer vous permet de :
- Tester des requêtes et mutations
- Parcourir le schéma complet
- Déboguer avant de coder
Si vous êtes connecté à Legalesign, l’authentification est automatique.
Pour un premier exemple minimal fonctionnel, rendez-vous sur le Démarrage rapide.
Trouvez des requêtes et mutations prêtes à l’emploi en inspectant les requêtes réseau dans la console de l’application web Legalesign.
Accès programmatique
GraphQL supporte deux modes d’authentification :
| Mode | Couverture | En-tête | Idéal pour |
|---|---|---|---|
| OAuth 2.0 | Sous-ensemble supporté seulement (les opérations avec clé API, sauf generateComponentToken) | Authorization: Bearer <access-token> | Intégrations agissant au nom d’un utilisateur Legalesign, qui se connecte et consent |
| Clé API | Sous-ensemble supporté seulement | Authorization: Bearer <api-key> | Automatisation côté serveur et flux d’envoi/lecture courants |
Pour OAuth 2.0, enregistrez un client dans le Portail développeur et suivez le guide client OAuth.
Pour l’authentification par clé API, créez une clé activée GraphQL dans le Portail développeur et consultez les opérations GraphQL supportées pour les requêtes et mutations prises en charge.
Voir le guide d’authentification pour plus de détails.
Utilisez-vous un outil de codage IA ?
Si vous utilisez Cursor, Claude, Windsurf ou un autre assistant IA, connectez-le au serveur de docs Legalesign pour une aide contextuelle pendant que vous codez. Voir Connectez votre outil IA.
Prochaines étapes
- Commencez avec le Démarrage rapide
- Ajoutez des événements en temps réel avec le Démarrage rapide Websocket en temps réel
- Explorez le schéma dans le GraphQL Explorer
- Choisissez OAuth 2.0 ou authentification par clé API pour un accès programmatique
- Suivez un tutoriel : Node.js · C#
- Connectez votre outil IA pour une assistance de codage contextuelle
GraphQL vous donne la même puissance que l’application web Legalesign — si vous pouvez le faire là-bas, vous pouvez le faire via l’API.