Dilysu gyda'r API
Mae GraphQL yn cefnogi dau fodd dilysu:
| Modd | Gorchuddiaeth | Pennyn | Gorau ar gyfer |
|---|---|---|---|
| OAuth 2.0 | Is-set cefnogedig yn unig (gweithrediadau allwedd API, heblaw generateComponentToken) | Authorization: Bearer <access-token> | Integreiddiadau sy'n gweithredu ar ran defnyddiwr Legalesign, sy'n mewngofnodi ac yn rhoi caniatâd |
| Allwedd API | Is-set cefnogedig yn unig | Authorization: Bearer <api-key> | Awtomatiaeth ochr y gweinydd a llifiau anfon/darllen cyffredin |
Mae'r ddau fodd yn cefnogi'r un set o weithrediadau. Mae tocyn OAuth yn gweithredu fel y defnyddiwr a wnaeth ei awdurdodi, gyda'r caniatâd gan y defnyddiwr hwnnw.
Dilysu Allwedd API
Creu allwedd API sydd wedi'i galluogi ar gyfer GraphQL yn y Porth Datblygwr, yna anfonwch fel tocyn bearer:
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 } }"}
Mae GraphQL yn gofyn am
Authorization: Beareryn unig. Nid oes angenx-organisationna phenynnau arfer eraill.
Gwiriwch y gweithrediadau GraphQL cefnogedig a'r bathodynnau awdurdodi ar dudalennau cyfeirnod chwilio a mudo cyn defnyddio gweithrediad gyda allwedd API.
Dilysu OAuth 2.0
Mae OAuth 2.0 yn caniatáu i'ch cais weithredu ar ran defnyddiwr Legalesign penodol, ar gyfer y gweithrediadau y mae allweddi API yn eu cefnogi, heblaw generateComponentToken (gweler y gweithrediadau GraphQL cefnogedig). Mae'r defnyddiwr yn mewngofnodi ac yn rhoi caniatâd yn eglur. Nid yw eich cais byth yn trin eu cyfrinair.
Cofrestrwch gwsmer OAuth yn y Porth Datblygwr, yna dilynwch y canllaw cwsmer OAuth ar gyfer camau integreiddio llawn. Mae eich gweinydd yn dilysu i'r pwynt tocyn gyda chyfrinach y cwsmer, yn ogystal â PKCE.
Unwaith y cewch docyn mynediad, defnyddiwch ef yn union fel allwedd API:
POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer eyJ...
{"query": "{ user { id email } }"}
Mae tocynnau mynediad yn dod i ben ar ôl awr. Defnyddiwch y tocyn adnewyddu i gael un newydd heb i'r defnyddiwr ail-dilysu. Mae tocyn adnewyddu yn dod i ben os na ddefnyddir ef am 30 diwrnod, ac mae awdurdodiad y defnyddiwr yn para 12 mis o'r tro diwethaf iddo gymeradwyo eich cais, ar ôl hynny mae'r defnyddiwr yn awdurdodi eto. Mae tocynnau adnewyddu yn cylchdroi ar bob defnydd, felly adnewyddwch o un lle ar y tro a chadw'r tocyn newydd bob tro.
Derbynnir tocynnau OAuth gan API GraphQL yn unig, nid API REST. Mae tocyn yn gweithredu gyda chaniatadau'r defnyddiwr awdurdodedig ei hun, ac ar hyn o bryd nid yw wedi'i gyfyngu i ddata eich sefydliad. Gweler y canllaw cwsmer OAuth am beth mae hynny'n ei olygu cyn cofrestru cwsmer.
Awdurdodi Widget a Chydran
Mae widgetiau dilysedig megis y Gwylwr Dogfen a'r Llofnodwr angen tocyn byrhoedlog a basiwyd i'w nodwedd token. Defnyddiwch allwedd API i alw generateComponentToken ochr y gweinydd a thresglwyddo'r tocyn a dderbynnir i'r widget.
Gweler Awdurdodi Widget ar gyfer y llif llawn a chanllaw diogelwch porwr.