Dearbhaich leis an API
Tha GraphQL a’ toirt taic do dhà mhodh dearbhaidh:
| Modh | Còmhdach | Ceann-làir | As fheàrr airson |
|---|---|---|---|
| SRP | Schema GraphQL slàn | Authorization: Bearer <access-token> | Amalachadh slàn |
| Iuchair API | Fo-shreath a tha air a toirt taic do | Authorization: Bearer <api-key> | Fèin-ghluasad taobh-frithealaidh agus sruthan cumanta cur/aithne |
Is e SRP am modh dearbhaidh buileach-scheama. Faodaidh iuchraichean API a tha air an cruthachadh anns a’ Phortail Leasachaidh cothrom fhaighinn air fo-shreath a tha air a toirt taic do obrachdan GraphQL.
Dearbhadh air Iuchair API
Cruthaich iuchair API gnìomhach le GraphQL anns a’ Phortail Leasachaidh, an uairsin cuir a-steach 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 } }"}
Thoir sùil air an iomradh GraphQL airson iuchair API agus na bagaichean dearbhaidh air duilleagan iomraidh ceist is gluasad mus cleachd thu obrachadh le iuchair API.
Ùghdarras airson Widget agus Pàirtiche
Feumaidh widgets a tha air an dearbhadh, leithid an Sealladair Sgrìobhainnean agus an Synnach, token a chaidh a chur seachad air an token feart aca.
Tha dà dhòigh a th’ air an toirt taic dha taobh-frithealaidh gus am token sin a thoirt seachad:
| Tùs an token | Mar a tha e ag obair |
|---|---|
| SRP JWT | Bidh an frithealaiche agad a’ cleachdadh SRP gus token JWT fhaighinn agus a’ cur an JWT sin chun widget |
| Token pàirtiche | Bidh an frithealaiche agad a’ cleachdadh iuchair API gus generateComponentToken a ghairm, an uairsin a’ cur an token a thilleas chun widget |
Tha generateComponentToken ri fhaighinn a-mhàin le iuchair API agus tha e a’ toirt seachad token beagan-ùineach do widgets. Tha SRP fhathast na roghainn buileach-scheama nuair a bu chòir don chùl-raon agad JWT a thoirt seachad gu dìreach.
Tha barrachd fiosrachaidh mun t-sruth token pàirtiche agus stiùireadh tèarainteachd brobhsair ri fhaighinn ann an Ùghdarras Widget.
Dearbhadh SRP
Cleachd SRP nuair a dh’fheumas tu cothrom air an t-scheama GraphQL gu lèir.
Creideasan API
Gus dearbhadh SRP a chleachdadh, cuir fios gu taic Legalesign airson na creideasan agus mion-fhiosrachadh airson do amalachadh.