Dearbhaich leis an API
Tha taic aig GraphQL airson dà dhòigh dearbhaidh:
| Modh | Raon-còmhnaidh | Header | As fheàrr airson |
|---|---|---|---|
| OAuth 2.0 | Fo-chuid taic a-mhàin (na gnìomhan API-key, ach a-mhàin generateComponentToken) | Authorization: Bearer <access-token> | Amalachadh a bhios ag obair air feadhainn cleachdaiche Legalesign, a logas a-steach agus a bheir cead |
| API Key | Fo-chuid taic a-mhàin | Authorization: Bearer <api-key> | Fèin-obrachadh taobh an t-seirbheis agus sruthan cumanta cur/aithris |
Tha an dà dhòigh a’ toirt taic don aon t-sreath de ghnìomhan. Bidh token OAuth a’ dèanamh gnìomhan mar an neach-cleachdaidh a dh’ùghdarraich e, a rèir ceadan an neach-cleachdaidh sin.
Dearbhadh Cuir a-steach le API Key
Cruthaich iuchair API le taic GraphQL anns an Developer Portal, an uair sin cuir air adhart 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 } }"}
Feumaidh GraphQL dìreach
Authorization: Bearer. Chan eil feum airx-organisationno ceann-sgrìoban eile gnàthaichte.
Thoir sùil air na gnìomhan GraphQL taicichte agus an comharra dearbhaidh air duilleagan iomraidh sgrùdaidh is atharrachaidh mus cleachd thu gnìomh le iuchair API.
Dearbhadh OAuth 2.0
Leigidh OAuth 2.0 leis an aplacaid agad obrachadh air an fhigheadair neach-cleachdaidh Legalesign sònraichte, airson na gnìomhan a tha iuchraichean API a’ toirt taic dhaibh, ach a-mhàin generateComponentToken (faic na gnìomhan GraphQL taicichte). Logas an neach-cleachdaidh a-steach agus tha e a’ toirt comas soilleir dha. Chan obraich an aplacaid agad le am facal-faire riamh.
Clàraich neach-dèiligidh OAuth anns an Developer Portal, an uair sin lean an stiùireadh neach-dèiligidh OAuth airson an ceumannan amalachaidh gu lèir. Bidh an frithealaiche agad a’ dearbhadh chun deireadh-tokain leis an dìomhaireachd neach-dèiligidh, a bharrachd air PKCE.
Nuair a tha token ruigsinneachd agad, cleachd e mar a chleachdas tu iuchair API gu h-aon chumaidh:
POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer eyJ...
{"query": "{ user { id email } }"}
Bidh tokenan ruigsinneachd a’ crìonadh às dèidh uair a thìde. Cleachd an token ath-nuadhachaidh airson fear ùr fhaighinn gun a h-uile uair logadh a-steach leis an neach-cleachdaidh. Bidh token ath-nuadhachaidh a’ crìonadh ma thèid a chleachdadh airson 30 latha gun bhriseadh, agus bidh cead an neach-cleachdaidh gu lèir a’ mairsinn 12 mìosan bhon uair dheireanach a ghabh iad ris an aplacaid agad, an uair sin feumaidh an neach-cleachdaidh cead a thoirt a-rithist. Bidh tokenan ath-nuadhachaidh a’ tionndadh air gach cleachdadh, mar sin ath-nuadhaich bho aon àite aig àm agus sàbhail an token ùr gach turas.
Gheibhear tokenan OAuth anns an API GraphQL a-mhàin, chan ann anns an API REST. Bidh token a’ dèanamh gnìomhan leis na ceadan a tha aig an neach-cleachdaidh a dh’ùghdarraich e, agus on seo cha deach a chuingealachadh ri dàta do bhuidheann-frithealaidh. Faic an stiùireadh neach-dèiligidh OAuth airson fiosrachadh air seo mus clàraich thu neach-dèiligidh.
Ùghdarras Widget agus Earrann
Feumaidh widgets dearbhaichte leithid an Neach-coimhead Sgrìobhainn agus Fuirichich token beaga ùr a tha air a phasgadh dhan chuir a-steach token aca. Cleachd iuchair API gus gairm a dhèanamh air generateComponentToken taobh an t-seirbheis agus cuir an token air a thilleadh chun widget.
Faic Ùghdarras Widget airson an sruth slàn agus stiùireadh tèarainteachd brobhsair.