Αυθεντικοποίηση με το API
Το GraphQL υποστηρίζει δύο τρόπους αυθεντικοποίησης:
| Τρόπος | Κάλυψη | Επικεφαλίδα | Ιδανικό για |
|---|---|---|---|
| OAuth 2.0 | Υποστηρίζεται μόνο υποσύνολο (οι λειτουργίες με API-key, εκτός του generateComponentToken) | Authorization: Bearer <access-token> | Ενσωματώσεις που ενεργούν εκ μέρους χρήστη του Legalesign, ο οποίος συνδέεται και δίνει τη συγκατάθεση |
| API Key | Υποστηρίζεται μόνο υποσύνολο | Authorization: Bearer <api-key> | Αυτοματισμός server-side και κοινές ροές αποστολής/ανάγνωσης |
Και οι δύο τρόποι υποστηρίζουν το ίδιο σύνολο λειτουργιών. Ένα OAuth token λειτουργεί ως ο χρήστης που το εξουσιοδότησε, με τα αντίστοιχα δικαιώματά του.
Αυθεντικοποίηση με API Key
Δημιουργήστε ένα API key με υποστήριξη GraphQL στο Developer Portal, και στη συνέχεια στείλτε το ως 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 } }"}
Το GraphQL απαιτεί μόνο
Authorization: Bearer. Δεν απαιτούνταιx-organisationή άλλες προσαρμοσμένες επικεφαλίδες.
Ελέγξτε τις υποστηριζόμενες λειτουργίες GraphQL και τα σήματα αυθεντικοποίησης στις σελίδες αναφοράς query και mutation πριν χρησιμοποιήσετε μια λειτουργία με API key.
Αυθεντικοποίηση OAuth 2.0
Το OAuth 2.0 επιτρέπει στην εφαρμογή σας να ενεργεί εκ μέρους ενός συγκεκριμένου χρήστη Legalesign, για τις λειτουργίες που υποστηρίζουν τα API keys, εκτός του generateComponentToken (δείτε τις υποστηριζόμενες λειτουργίες GraphQL). Ο χρήστης συνδέεται και δίνει ρητή συγκατάθεση. Η εφαρμογή σας δεν χειρίζεται ποτέ τον κωδικό πρόσβασής του.
Καταχωρίστε έναν OAuth client στο Developer Portal, και μετά ακολουθήστε τον οδηγό OAuth client για τα πλήρη βήματα ενσωμάτωσης. Ο server σας αυθεντικοποιείται στο token endpoint με το client secret, καθώς επίσης και με PKCE.
Μόλις έχετε ένα access token, χρησιμοποιήστε το όπως ακριβώς και ένα API key:
POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer eyJ...
{"query": "{ user { id email } }"}
Τα access tokens λήγουν μετά από μία ώρα. Χρησιμοποιήστε το refresh token για να πάρετε καινούριο χωρίς να απαιτείται εκ νέου αυθεντικοποίηση του χρήστη. Ένα refresh token λήγει αν δεν χρησιμοποιηθεί για 30 ημέρες, και η εξουσιοδότηση του χρήστη συνολικά διαρκεί 12 μήνες από την τελευταία έγκριση της εφαρμογής σας, μετά την οποία ο χρήστης εξουσιοδοτεί ξανά. Τα refresh tokens ανανεώνονται σε κάθε χρήση, οπότε κάνετε ανανέωση από ένα σημείο κάθε φορά και αποθηκεύετε το νέο token κάθε φορά.
Τα OAuth tokens γίνονται δεκτά μόνο από το GraphQL API, όχι από το REST API. Ένα token ενεργεί με τα δικαιώματα του εξουσιοδοτημένου χρήστη και δεν περιορίζεται επί του παρόντος στα δεδομένα του οργανισμού σας. Δείτε τον οδηγό OAuth client για τι σημαίνει αυτό πριν καταχωρίσετε client.
Άδεια Widget και Component
Τα αυθεντικοποιημένα widgets όπως ο Document Viewer και ο Signer χρειάζονται ένα βραχυχρόνιο token που περνάει ως η παράμετρος token. Χρησιμοποιήστε ένα API key για να καλέσετε server-side το generateComponentToken και περάστε το επιστρεφόμενο token στο widget.
Δείτε το Widget Authorization για τη πλήρη ροή και τις οδηγίες ασφαλείας στο πρόγραμμα περιήγησης.