Authentifizierung mit der API
GraphQL unterstützt zwei Authentifizierungsmodi:
| Modus | Abdeckung | Header | Am besten geeignet für |
|---|---|---|---|
| SRP | Vollständiges GraphQL-Schema | Authorization: Bearer <access-token> | Komplette Integrationen |
| API-Schlüssel | Nur unterstützter Teilbereich | Authorization: Bearer <api-key> | Serverseitige Automatisierung und gängige Sende-/Lesevorgänge |
SRP ist die Authentifizierungsmethode mit vollständigem Schema. API-Schlüssel, die im Developer Portal erstellt wurden, können auf einen unterstützten Teilbereich der GraphQL-Operationen zugreifen.
API-Schlüssel-Authentifizierung
Erstellen Sie einen GraphQL-aktivierten API-Schlüssel im Developer Portal und senden Sie ihn dann als Bearer-Token:
POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer ak_<environment>_<key-id>.<secret>
{"query": "{ user { id email } }"}
Überprüfen Sie die API-Key GraphQL-Referenz sowie die Authentifizierungs-Abzeichen auf den Referenzseiten für Abfragen und Mutationen, bevor Sie eine Operation mit einem API-Schlüssel verwenden.
Widget- und Komponentenautorisierung
Authentifizierte Widgets, wie der Dokumenten-Viewer, benötigen einen Token, der ihrem token-Attribut übergeben wird.
Es gibt zwei unterstützte serverseitige Möglichkeiten, diesen Token bereitzustellen:
| Tokenquelle | Funktionsweise |
|---|---|
| SRP JWT | Ihr Server verwendet SRP, um ein JWT-Access-Token zu erhalten, und übergibt dieses JWT an das Widget |
| Komponententoken | Ihr Server verwendet einen API-Schlüssel, um generateComponentToken aufzurufen und übergibt dann das zurückgegebene token an das Widget |
generateComponentToken ist ausschließlich für API-Schlüssel und gibt einen kurzlebigen Token für Widgets zurück. SRP bleibt die Vollschema-Option, wenn Ihr Backend ein JWT direkt bereitstellen soll.
Siehe Widget-Autorisierung für den vollständigen Ablauf des Komponententokens und Hinweise zur Browser-Sicherheit.
SRP-Authentifizierung
Verwenden Sie SRP, wenn Sie vollen Zugriff auf das GraphQL-Schema benötigen.
API-Anmeldedaten
Um SRP-Authentifizierung zu nutzen, kontaktieren Sie den Legalesign-Support, um die Anmeldedaten und Details für Ihre Integration zu erhalten.