Dilysu gyda'r API
Mae GraphQL yn cefnogi dau fodd dilysu:
| Modd | Cwmpas | Pennawd | Gorau ar gyfer |
|---|---|---|---|
| SRP | Cynllun llawn GraphQL | Authorization: Bearer <access-token> | Integreiddiadau gweithredol |
| API Key | Is-set cymorth yn unig | Authorization: Bearer <api-key> | Awtomeiddio ochr y gweinydd a llifau anfon/darllen cyffredin |
SRP yw'r dull dilysu cynllun llawn. Gall allweddi API a grëir yn y Porth Datblygwr gael mynediad at is-set cymorth o weithrediadau GraphQL.
Dilysu Allwedd API
Creu allwedd API wedi galluogi GraphQL yn y Porth Datblygwr, yna ei anfon 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 } }"}
Edrychwch ar y cyfeirnod GraphQL allwedd API a'r bathodynnau dilysu ar dudalennau cyfeiriad holi a newid cyn defnyddio gweithrediad gyda allwedd API.
Awdurdodi Widget a Chydran
Mae angen tocyn a basir i widgetiau dilysedig, megis y Gwylwr Dogfen a'r Llofnodwr, wrth ddefnyddio eu priodoledd token.
Mae dau ffordd a gefnogir ochr y gweinydd i ddarparu'r tocyn hwnnw:
| Ffynhonnell Tocyn | Sut mae'n gweithio |
|---|---|
| SRP JWT | Mae eich gweinydd yn defnyddio SRP i gael tocyn mynediad JWT ac yn pasio'r JWT hwnnw i'r widget |
| Tocyn Cydran | Mae eich gweinydd yn defnyddio allwedd API i alw ar generateComponentToken, ac yna'n pasio'r token a ddychwelir i'r widget |
Mae generateComponentToken ar gyfer allwedd API yn unig a dychwelyd tocyn byr-dymor ar gyfer widgetiau. Mae SRP yn parhau i fod yn opsiwn cynllun llawn pan ddylai eich cefndir ddarparu JWT yn uniongyrchol.
Gweler Awdurdodi Widget am y llif tocyn cydran llawn a chanllawiau diogelwch porwr.
Dilysu SRP
Defnyddiwch SRP pan fydd angen mynediad llawn i gynllun GraphQL arnoch.
Credyntiau API
I ddefnyddio dilysu SRP, cysylltwch â chefnogaeth Legalesign i gael y credyntiau a manylion ar gyfer eich integreiddiad.