Legalesign GraphQL API
Um die Legalesign API zu nutzen, müssen Sie uns kontaktieren, um die API-Nutzung für Ihr Konto genehmigen zu lassen.
Legalesign bietet zwei APIs für die Integration von elektronischen Signaturen an:
- REST API – Schneller Einstieg, traditionelles Format
- GraphQL API – Volle Leistung, flexibler
Dieser Leitfaden konzentriert sich auf GraphQL. Sie benötigen Kenntnisse in JSON und grundlegende Erfahrung mit Webanfragen.
Warum GraphQL wählen?
REST ist zuverlässig, bekannt und bleibt bestehen. GraphQL bietet Ihnen eine andere Methode, Daten abzurufen und zu strukturieren. Bei Legalesign ist GraphQL die erstklassige API – jeder Teil der Plattform ist darüber zugänglich.
| REST | GraphQL | |
|---|---|---|
| Endpunkte | Mehrere (/users, /contracts, etc.) | Einer (/graphql) |
| Datenabruf | Fest pro Endpunkt | Vom Client definierte Abfragen |
| Über-/Unterabruf | Häufig | Reduziert |
| Versionierung | Versioniert (/v1/, /v2/) | Ohne Versionierung – neue Felder brechen bestehende Abfragen nicht |
| Authentifizierung | API-Schlüssel | SRP oder API-Schlüssel-Untermenge |
GraphQL ermöglicht Ihnen den vollständigen Zugriff auf die Funktionen von Legalesign:
- Fordern Sie nur die Daten an, die Sie benötigen
- Ein einzelner Endpunkt für alles
- Gleiche Leistung wie die Webanwendung
TypeScript/JavaScript-Entwickler
Berücksichtigen Sie das TS/JS SDK für allgemeine Anwendungsfälle, aber das Erlernen von GraphQL bietet Ihnen vollständigen Plattformzugriff. SDK vs GraphQL vergleichen.
Probieren Sie GraphQL jetzt aus
Beginnen Sie mit dem GraphQL Explorer (erfordert ein aktives Konto).
Der Explorer ermöglicht Ihnen:
- Abfragen und Mutationen testen
- Das komplette Schema durchsuchen
- Vor dem Programmieren debuggen
Wenn Sie bei Legalesign angemeldet sind, erfolgt die Authentifizierung automatisch.
Für ein minimales erstes funktionierendes Beispiel gehen Sie zu Quickstart.
Finden Sie fertige Abfragen und Mutationen, indem Sie Netzwerk-Anfragen in der Konsole der Legalesign-Webapp inspizieren.
Programmatischer Zugriff
GraphQL unterstützt zwei Authentifizierungsmodi:
| Modus | Abdeckung | Header | Am besten für |
|---|---|---|---|
| SRP | Volles GraphQL-Schema | Authorization: Bearer <access-token> | Komplette Integrationen |
| API-Schlüssel | Nur unterstütztes Teilset | Authorization: Bearer <api-key> | Serverseitige Automatisierung und gängige Sende-/Lesevorgänge |
Für die SRP-Authentifizierung kontaktieren Sie den Legalesign Support, um Zugangsdaten und Details für Ihre Integration zu erhalten.
Für die API-Schlüssel-Authentifizierung erstellen Sie einen GraphQL-fähigen Schlüssel im Developer Portal und prüfen Sie die API-Key GraphQL-Referenz für unterstützte Abfragen und Mutationen.
Weitere Details finden Sie im Authentifizierungsleitfaden.
Verwenden Sie ein KI-Coding-Tool?
Wenn Sie Cursor, Claude, Windsurf oder einen anderen KI-Assistenten verwenden, verbinden Sie ihn mit dem Legalesign-Dokumentationsserver für kontextbezogene Hilfe während des Codierens. Siehe Ihr KI-Tool verbinden.
Nächste Schritte
- Starten Sie mit dem Quickstart
- Fügen Sie Echtzeit-Events mit dem Real-Time Websocket Quickstart hinzu
- Erkunden Sie das Schema im GraphQL Explorer
- Wählen Sie SRP- oder API-Schlüssel-Authentifizierung für den programmatischen Zugriff
- Folgen Sie einem Tutorial: Node.js · C#
- Verbinden Sie Ihr KI-Tool für kontextbezogene Codierunterstützung
GraphQL gibt Ihnen dieselbe Leistung wie die Legalesign-Webanwendung – wenn Sie es dort können, können Sie es auch mit der API.