Aller au contenu principal

API GraphQL Legalesign

L’accès à l’API nécessite une approbation

Pour utiliser l’API Legalesign, vous devez nous contacter afin d’obtenir l’autorisation d’utilisation de l’API pour votre compte.

Legalesign propose deux API pour l’intégration de la signature électronique :

  • API REST – Démarrage rapide, format traditionnel
  • API GraphQL – Pleine puissance, plus flexible

Ce guide se concentre sur GraphQL. Vous aurez besoin de connaissances en JSON et d’une expérience basique des requêtes web.

Pourquoi choisir GraphQL ?

REST est fiable, familier et pérenne. GraphQL vous offre une autre façon de concevoir la récupération et la structuration des données. Chez Legalesign, GraphQL est l’API de premier plan — chaque partie de la plateforme y est disponible.

RESTGraphQL
Points de terminaisonMultiples (/users, /contracts, etc.)Unique (/graphql)
Récupération des donnéesFixée par point de terminaisonRequêtes définies par le client
Sur/sous-récupérationCouranteRéduite
VersionnageVersionné (/v1/, /v2/)Sans version — les nouveaux champs ne cassent pas les requêtes existantes
AuthentificationClé APISRP ou sous-ensemble de clé API

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

Considérez le SDK TS/JS pour les cas d’utilisation courants, mais apprendre GraphQL vous donne un accès complet à la plateforme. Comparer le SDK et GraphQL.

Essayez GraphQL Maintenant

Commencez avec le GraphQL Explorer (requiert un compte actif).

L’Explorer vous permet de :

  • Tester des requêtes et mutations
  • Parcourir le schéma complet
  • Déboguer avant de coder
info

Si vous êtes connecté à Legalesign, l’authentification est automatique.

Pour un premier exemple minimal, rendez-vous sur le Démarrage rapide.

astuce

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 :

ModeCouvertureEntêteIdéal pour
SRPSchéma GraphQL completAuthorization: Bearer <access-token>Intégrations complètes
Clé APISous-ensemble supporté uniquementAuthorization: Bearer <api-key>Automatisation côté serveur et flux d’envoi/lecture courants

Pour l’authentification SRP, contactez le support Legalesign pour obtenir les identifiants et les détails de votre intégration.

Pour l’authentification par clé API, créez une clé activée pour GraphQL dans le Portail développeur et consultez la référence GraphQL de la clé API pour les requêtes et mutations supportées.

Consultez le guide d’authentification pour plus de détails.

Vous utilisez un Outil de Codage IA ?

Si vous utilisez Cursor, Claude, Windsurf ou un autre assistant IA, connectez-le au serveur de documentation Legalesign pour une aide contextuelle pendant que vous codez. Voir Connectez votre outil IA.

Prochaines étapes

  1. Commencez par le Démarrage rapide
  2. Ajoutez des événements en temps réel avec le Démarrage rapide Websocket temps réel
  3. Explorez le schéma dans le GraphQL Explorer
  4. Choisissez SRP ou authentification par clé API pour l’accès programmatique
  5. Suivez un tutoriel : Node.js · C#
  6. 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 avec l’API.