Sleamhnú go príomh-ábhar

Fíordheimhniú leis an API

Tacaíonn GraphQL le dhá mhodh fíordheimhnithe:

MódClúdachCeannteidealIs fearr le haghaidh
OAuth 2.0Fochomhartha tacaíochta amháin (na hoibríochtaí API-key, seachas generateComponentToken)Authorization: Bearer <access-token>Comhtháthaithe ag gníomhú thar ceann úsáideora Legalesign, a logálann isteach agus a dheonaíonn
Eochair APIFochomhartha tacaíochta amháinAuthorization: Bearer <api-key>Uathoibriú taobh freastalaí agus sreafaí coiteanna seol/léigh

Tacaíonn an dá mhód leis an mbailiúchán céanna oibríochtaí. Gníomhaíonn token OAuth mar an t-úsáideoir a d’údaraithe é, leis na ceadanna atá ag an úsáideoir sin.

Fíordheimhniú Eochair API​

Cruthaigh eochair API le tacaíocht GraphQL sa Developer Portal, ansin seol í mar token 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 } }"}

Ní theastaíonn ach Authorization: Bearer ó GraphQL. Níl aon x-organisation nó ceannlíne saincheaptha eile de dhíth.

Seiceáil na hoibríochtaí GraphQL tacaíochta agus na brataí auth ar na leathanacha tagartha fiosrúcháin agus athruithe sular úsáidtear oibríocht le eochair API.

Fíordheimhniú OAuth 2.0​

Ligeann OAuth 2.0 do do iarratas gníomhú thar ceann úsáideoir Legalesign sonrach, don na hoibríochtaí a thacaíonn eochracha API leo, seachas generateComponentToken (féach na hoibríochtaí GraphQL tacaíochta). Logálann an t-úsáideoir isteach agus tugann sé cead go soiléir. Ní láimhseálann do iarratas riamh a bpasfhocal.

Cláraigh cliant OAuth sa Developer Portal, ansin lean an treoir chliaint OAuth chun céimeanna iomlána comhtháthaithe a dhéanamh. Déan do fhreastalaí fíordheimhniú ag deireadhphointe token leis an rún cliant, chomh maith le PKCE.

Nuair a bheidh token rochtana agat, bain úsáid as go díreach mar eochair API:

POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer eyJ...

{"query": "{ user { id email } }"}

Bíonn token rochtana bailí ar feadh uair an chloig amháin. Bain úsáid as an token athnuachana chun ceann nua a fháil gan an t-úsáideoir a athfhíordheimhniú. Éiríonn token athnuachana neamhbhailí má dhéantar neamhúsáid air ar feadh 30 lá, agus mhaireann údarú iomlán an úsáideora 12 mhí ón dáta a ndearna siad le déanaí do iarratas a cheadú, ina dhiaidh sin ceadaíonn an t-úsáideoir arís é. Rotálaítear token athnuachana gach uair a úsáidtear é, mar sin déan athnuachan ó áit amháin ag an am agus coinnigh an token nua gach uair.

nóta

Ghlactar le token OAuth leis an API GraphQL amháin, ní leis an API REST. Gníomhaíonn token le ceadanna úsáideora údaraithe, agus faoi láthair níl sé teoranta do shonraí d’eagraíocht agat. Féach an treoir chliaint OAuth chun a thuiscint cad a chiallaíonn sin sula ndéanann tú cliant a chlárú.

Údarású Fíomh Widgead agus Comhpháirte​

Teastaíonn token gearrbhreise, a tharchuireann don tréith token acu, ó widgeanna fíordheimhnithe cosúil leis an Document Viewer agus an Signer. Bain úsáid as eochair API chun glaoch ar generateComponentToken ar an taobh freastalaí agus pas a thabhairt don token ar ais chuig an widget.

Féach Údarású Widgead don sreabh iomlán agus an treoir sábháilteachta brabhsálaí.

Export This Article

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