Zum Hauptinhalt springen

Legalesign GraphQL API

Legalesign bietet zwei APIs für die Integration von E-Signaturen an:

  • REST API – Schneller Einstieg, traditionelles Format
  • GraphQL API – Volle Leistung, flexibler

Dieser Leitfaden konzentriert sich auf GraphQL. Sie benötigen JSON-Kenntnisse und grundlegende Erfahrung mit Webanfragen.

Warum GraphQL wählen?​

REST ist zuverlässig, bekannt und bleibt bestehen. GraphQL bietet Ihnen eine andere Denkweise beim Abrufen und Formen von Daten. Bei Legalesign ist GraphQL die primäre API – jeder Teil der Plattform ist darüber verfügbar.

RESTGraphQL
EndpunkteMehrere (/users, /contracts usw.)Einzelner (/graphql)
DatenabrufFest pro EndpunktVom Client definierte Abfragen
Über-/UnterabrufHäufigReduziert
VersionierungVersioniert (/v1/, /v2/)Versionslos – neue Felder brechen keine bestehenden Abfragen
AuthentifizierungAPI-SchlüsselOAuth 2.0 oder API-Schlüssel (gleich unterstützter Teilumfang)

GraphQL gibt Ihnen vollen Zugriff auf die Funktionen von Legalesign:

  • Fordern Sie nur die Daten an, die Sie benötigen
  • Ein einziger Endpunkt für alles
  • Dieselbe Leistungsfähigkeit wie die Webanwendung

TypeScript/JavaScript Entwickler​

Erwägen Sie das TS/JS SDK für gängige Anwendungsfälle, aber das Erlernen von GraphQL ermöglicht Ihnen den vollständigen Plattformzugang. SDK vs GraphQL vergleichen.

Probieren Sie GraphQL jetzt aus​

Beginnen Sie mit dem GraphQL Explorer (erfordert aktives Konto).

Der Explorer ermöglicht Ihnen:

  • Abfragen und Mutationen testen
  • Das vollständige Schema durchsuchen
  • Vor dem Codieren debuggen
Info

Wenn Sie bei Legalesign eingeloggt sind, erfolgt die Authentifizierung automatisch.

Für ein minimales erstes funktionierendes Beispiel sehen Sie den Quickstart.

Tipp

Finden Sie fertige Abfragen und Mutationen, indem Sie die Netzwerkrequests in der Konsole der Legalesign-Webanwendung prüfen.

Programmatischer Zugang​

GraphQL unterstützt zwei Authentifizierungsmodi:

ModusUmfangHeaderAm besten geeignet für
OAuth 2.0Nur unterstützter Teilumfang (die API-Key-Operationen, außer generateComponentToken)Authorization: Bearer <access-token>Integrationen, die im Auftrag eines Legalesign-Benutzers handeln, der sich anmeldet und zustimmt
API-SchlüsselNur unterstützter TeilumfangAuthorization: Bearer <api-key>Serverseitige Automatisierung und gängige Sende-/Leseabläufe

Für OAuth 2.0 registrieren Sie einen Client im Developer Portal und folgen dem OAuth-Client-Leitfaden.

Für die Authentifizierung mit API-Schlüssel erstellen Sie einen GraphQL-fähigen Schlüssel im Developer Portal und prüfen die unterstützen GraphQL-Operationen für unterstützte Abfragen und Mutationen.

Siehe den Authentifizierungsleitfaden für weitere Details.

Verwenden Sie ein AI-Coding-Tool?​

Wenn Sie Cursor, Claude, Windsurf oder einen anderen KI-Assistenten verwenden, verbinden Sie ihn mit dem Legalesign-Dokumentenserver für kontextbewusste Hilfe beim Coden. Siehe Verbinden Sie Ihr AI-Tool.

Nächste Schritte​

  1. Beginnen Sie mit dem Quickstart
  2. Fügen Sie Echtzeit-Events mit dem Realtime-Websocket-Quickstart hinzu
  3. Erkunden Sie das Schema im GraphQL Explorer
  4. Wählen Sie OAuth 2.0- oder API-Key-Authentifizierung für den programmatischen Zugang
  5. Folgen Sie einem Tutorial: Node.js · C#
  6. Verbinden Sie Ihr AI-Tool für kontextbewusste Codierungshilfe

GraphQL gibt Ihnen dieselbe Leistungsfähigkeit wie die Legalesign-Webanwendung – wenn Sie es dort können, können Sie es auch mit der API.