Aller au contenu principal

Legalesign GraphQL API

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

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

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

Pourquoi choisir GraphQL ?

REST est fiable, familier, et là pour rester. GraphQL vous offre une façon différente de penser la récupération et la structuration des données. Chez Legalesign, GraphQL est l’API de première classe — chaque partie de la plateforme est accessible via elle.

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

GraphQL vous donne un accès complet aux fonctionnalités de Legalesign :

  • Demandez uniquement 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’usage courants, mais apprendre GraphQL vous donne un accès complet à la plateforme. Comparer SDK et GraphQL.

Essayez GraphQL Maintenant

Commencez avec le GraphQL Explorer (nécessite 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 et fonctionnel, rendez-vous sur le Quickstart.

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 :

ModeCouvertureEn-tê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 courants d’envoi/lecture

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

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

Voir 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 docs Legalesign pour une aide contextuelle pendant que vous codez. Voir Connectez votre outil IA.

Prochaines étapes

  1. Commencez avec le Quickstart
  2. Ajoutez des événements en temps réel avec le Quickstart Websocket temps réel
  3. Explorez le schéma dans le GraphQL Explorer
  4. Choisissez l’authentification SRP ou clé API pour un accès programmatique
  5. Suivez un tutoriel : Node.js · C#
  6. Connectez votre outil IA pour une assistance au codage contextuelle

GraphQL vous offre la même puissance que l’application web Legalesign — si vous pouvez le faire là, vous pouvez le faire avec l’API.