Leum gu prìomh susbaint

Legalesign GraphQL API

Tha Legalesign a’ tabhann dà API airson amalachadh soidhnidh-dealbh-dhìreach:

  • REST API - Tòiseachadh luath, cruth traidiseanta
  • GraphQL API - Cumhachd làn, nas fhlexaile

Tha am mìneachadh seo ag amas air GraphQL. Feumaidh tu eòlas air JSON agus eòlas bunaiteach air iarraidh-lìn.

Carson Tagh GraphQL?​

Tha REST earbsach, eòlach, agus gu bhith ann fad na h-ùine. Bidh GraphQL a’ toirt dhut dòigh eadar-dhealaichte airson smaoineachadh mu bhith a’ tarraing agus a’ cumadh dàta. Aig Legalesign, is e GraphQL am API calas-càile — tha gach pàirt den àrd-ùrlar ri fhaighinn troimhe.

RESTGraphQL
Òrdughan-cuairteachaidhIomadh (/users, /contracts, msaa)Aon (/graphql)
Tarraing dàtaSònraichte gach òrdughCeistean air an mìneachadh leis a’ chliant
Cus / cus ghoidCumantaLùghdaichte
DreachadhLe dreach (/v1/, /v2/)Gun dreach — chan eil raointean ùra a’ briseadh cheistean a tha ann mu thràth
DearbhadhPrìomhach APIOAuth 2.0 no prìomhach API (an aon fo-shreath taiceil)

Tha GraphQL a’ toirt dhut faighinn gu feartan làn Legalesign:

  • Iarr dìreach an dàta a tha thu ag iarraidh
  • Aon òrdugh-cuairt airson a h-uile càil
  • An aon chumhachd ris a’ phrògram-lìn

Luchd-leasachaidh TypeScript/JavaScript​

Beachdaich air an TS/JS SDK airson cleachdaidhean cumanta, ach le bhith ag ionnsachadh GraphQL bheir thu cothrom làn air an àrd-ùrlar. Coimeas eadar SDK is GraphQL.

Feuch GraphQL A-nis​

Tòisich leis an GraphQL Explorer (feumaidh cunntas gnìomhach).

Leigidh an Explorer leat:

  • Deuchainn a dhèanamh air cheistean agus atharrachaidhean
  • Bruidhnidh tro shchema slàn
  • Fuasgladh às dèidh ro sgrìobhadh
fiosrachadh

Ma tha thu air logadh a-steach do Legalesign, tha an dearbhadh fèin-obrachail.

Airson eisimpleir obrach as ìsle, tadhl air an Tòiseachadh luath.

comhairle

Lorg cheistean agus atharrachaidhean deiseil le bhith a’ sgrùdadh iarrtasan lìonra sa cholbh Console prògram-lìn Legalesign.

Faighinn gu Prògram​

Tha GraphQL a’ toirt taic do dhà mhod de dearbhadh:

ModhRaonCinn-HeadersAirson an deagh fheum
OAuth 2.0Fo-shreath taiceil a-mhàin (gnìomhan prìomhach API, ach a-mhàin generateComponentToken)Authorization: Bearer <access-token>Amalachadh a’ giùlan làimh air son neach-cleachdaidh Legalesign, a bhios a’ logadh a-steach agus a’ toirt cead
Prìomhach APIFo-shreath taiceil a-mhàinAuthorization: Bearer <api-key>Gnìomhachd fèin-obrachail taobh na frithealaiche agus sruthan cumanta cur/leisgeul leughaidh

Airson OAuth 2.0, clàraich neach-cleachdaidh anns a’ Purt-dealbh-leasaiche agus lean an stiùireadh cleachdaiche OAuth.

Airson dearbhadh prìomhach API, cruthaich prìomhach le taic GraphQL anns a’ Purt-dealbh-leasaiche agus thoir sùil air na gnìomhan GraphQL taiceil airson na ceistean agus atharrachaidhean taiceil.

Fuirich ris an stiùireadh dearbhaidh airson barrachd mion-fhiosrachaidh.

A’ Cleachdadh Inneal Còdachaidh AI?​

Ma chleachdas tu Cursor, Claude, Windsurf, no neach-taic AI eile, ceangail e ris an frithealaiche sgrìobhaidh Legalesign airson cuideachadh a tha a’ toirt aire do cho-theacsa fhad ’s a bhios tu a’ còdachadh. Faic Ceangail do inneal AI.

Ceumannan an Ath-aislingidh​

  1. Tòisich leis an Tòiseachadh luath
  2. Cuir tachartasan beò le Tòiseachadh luath uèirliath beò
  3. Explore an schema anns an GraphQL Explorer
  4. Tagh dearbhadh OAuth 2.0 no prìomhach API airson faighinn gu prògram
  5. Lean oideachadh: Node.js · C#
  6. Ceangail do inneal AI airson cuideachadh còdaidh a rèir co-theacsa

Tha GraphQL a’ toirt dhut an aon chumhachd ris a’ phrògram-lìn Legalesign — ma gheibh thu cothrom an sin, gheibh thu cothrom leis an API.