Zum Hauptinhalt springen

Mit der API authentifizieren

GraphQL unterstützt zwei Authentifizierungsmodi:

ModusAbdeckungHeaderAm besten geeignet für
SRPVollständiges GraphQL-SchemaAuthorization: Bearer <access-token>Komplette Integrationen
API-SchlüsselNur unterstützter TeilAuthorization: Bearer <api-key>Serverseitige Automatisierung und häufige Send-/Lesevorgänge

SRP ist die Authentifizierungsmethode für das vollständige Schema. API-Schlüssel, die im Developer Portal erstellt werden, können auf einen unterstützten Teil der GraphQL-Operationen zugreifen.

API-Schlüssel-Authentifizierung

Erstellen Sie einen GraphQL-fähigen 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 und die Auth-Badges auf den Referenzseiten für Abfragen und Mutationen, bevor Sie eine Operation mit einem API-Schlüssel verwenden.

Widget- und Komponenten-Autorisierung

Authentifizierte Widgets, wie der Document Viewer und der Signer, benötigen ein Token, das an ihr token-Attribut übergeben wird.

Es gibt zwei unterstützte serverseitige Möglichkeiten, dieses Token bereitzustellen:

TokenquelleFunktionsweise
SRP JWTIhr Server verwendet SRP, um ein JWT-Access-Token zu erhalten, und übergibt dieses JWT an das Widget
Komponenten-TokenIhr Server verwendet einen API-Schlüssel, um generateComponentToken aufzurufen und übergibt dann das zurückgegebene token an das Widget

generateComponentToken ist nur mit API-Schlüssel zugänglich und liefert ein kurzlebiges Token für Widgets. SRP bleibt die Option für das vollständige Schema, wenn Ihr Backend ein JWT direkt bereitstellen soll.

Siehe Widget Authorization für den vollständigen Ablauf des Komponenten-Tokens und Sicherheitshinweise für den Browser.

SRP-Authentifizierung

Verwenden Sie SRP, wenn Sie Zugriff auf das vollständige GraphQL-Schema benötigen.

API-Zugangsdaten

Um die SRP-Authentifizierung zu nutzen, wenden Sie sich an den Legalesign-Support, um die Zugangsdaten und Details für Ihre Integration zu erhalten.

Export This Article

Save a copy of this page as PDF or plain text.