Legalesign GraphQL API
Legalesign bietet zwei APIs für die Integration von elektronischen Unterschriften:
- REST API – Schneller Einstieg, traditionelles Format
- GraphQL API – Volle Leistungsfähigkeit, 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 wird bleiben. GraphQL bietet Ihnen eine andere Art, über das Abrufen und Gestalten von Daten nachzudenken. Bei Legalesign ist GraphQL die erstklassige API – jeder Teil der Plattform ist darüber verfügbar.
| REST | GraphQL | |
|---|---|---|
| Endpoints | Mehrere (/users, /contracts usw.) | Einziger (/graphql) |
| Datenabruf | Festgelegt pro Endpoint | Vom Client definierte Abfragen |
| Über-/Unterabruf | Häufig | Reduziert |
| Versionierung | Versioniert (/v1/, /v2/) | Versionslos – neue Felder brechen bestehende Abfragen nicht |
| Authentifizierung | API-Schlüssel | SRP oder API-Schlüssel-Subset |
GraphQL gibt Ihnen vollständigen Zugang zu den Funktionen von Legalesign:
- Fordern Sie nur die Daten an, die Sie benötigen
- Ein einzelner Endpoint für alles
- Dieselbe Leistungsfähigkeit wie die Web-App
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. Vergleich SDK vs GraphQL.
Testen Sie GraphQL jetzt
Beginnen Sie mit dem GraphQL Explorer (erfordert aktives Konto).
Der Explorer ermöglicht Ihnen:
- Abfragen und Mutationen testen
- Das vollständige Schema durchsuchen
- Fehlerbehebung vor dem Codieren
Wenn Sie bei Legalesign eingeloggt sind, erfolgt die Authentifizierung automatisch.
Für ein minimales erstes funktionierendes Beispiel gehen Sie zum Quickstart.
Finden Sie fertige Abfragen und Mutationen, indem Sie Netzwerk-Anfragen in der Konsole der Legalesign-Web-App inspizieren.
Programmgesteuerter Zugriff
GraphQL unterstützt zwei Authentifizierungsmodi:
| Modus | Abdeckung | Header | Am besten geeignet für |
|---|---|---|---|
| SRP | Vollständiges GraphQL-Schema | Authorization: Bearer <access-token> | Umfassende Integrationen |
| API-Schlüssel | Nur unterstützter Teil | Authorization: Bearer <api-key> | Automatisierung serverseitig und gängige Sende-/Leseabläufe |
Für die SRP-Authentifizierung kontaktieren Sie den Legalesign Support, um die 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-Schlüssel GraphQL-Referenz für unterstützte Abfragen und Mutationen.
Siehe den Authentifizierungsleitfaden für weitere Details.
Verwenden Sie ein KI-Codierwerkzeug?
Wenn Sie Cursor, Claude, Windsurf oder einen anderen KI-Assistenten verwenden, verbinden Sie diesen mit dem Legalesign-Dokumentationsserver für kontextbewusste Hilfe während des Codierens. Siehe Verbinden Sie Ihr KI-Werkzeug.
Nächste Schritte
- Starten Sie mit dem Quickstart
- Fügen Sie Echtzeit-Events mit dem Echtzeit-Websocket Quickstart hinzu
- Erkunden Sie das Schema im GraphQL Explorer
- Wählen Sie SRP- oder API-Schlüssel-Authentifizierung für den programmgesteuerten Zugriff
- Folgen Sie einem Tutorial: Node.js · C#
- Verbinden Sie Ihr KI-Werkzeug für kontextbewusste Codierhilfe
GraphQL gibt Ihnen dieselbe Leistungsfähigkeit wie die Legalesign-Web-App – wenn Sie es dort können, können Sie es mit der API.