Sleamhnú go príomh-ábhar

API Legalesign GraphQL

Cuireann Legalesign dhá API ar fáil le haghaidh comhtháthú síniú leictreonach:

  • REST API - Tús tapa, formáid thraidisiúnta
  • GraphQL API - Cumhacht iomlán, níos solúbtha

Díríonn an treoir seo ar GraphQL. Beidh eolas agat ar JSON agus taithí bhunúsach ar iarratais gréasáin uait.

Cén Fáth a Roghnaigh GraphQL?​

Tá REST iontaofa, eolach agus anseo chun fanacht. Tugann GraphQL bealach difriúil duit smaoineamh ar an mbealach a ghearrtar agus a cruthaítear sonraí. Ag Legalesign, is é GraphQL an chéad API-rang — tá gach cuid den ardán ar fáil tríd.

RESTGraphQL
DeiridhphointíIolracha (/users, /contracts, srl.)Singil (/graphql)
Fáil sonraíSeasta in aghaidh an deiridhphointIarratais sainmhínithe ag an gcustaiméir
Strócadh ró-/fo-iarrataisCoitiantaLaghdaithe
LeaganúLeaganacha (/v1/, /v2/)Gan leaganacha — ní bhriseann réimsí nua na ceisteanna atá ann cheana
FíordheimhniúEochair APIOAuth 2.0 nó Eochair API (an fhoirmle tacaíochta chéanna)

Tugann GraphQL rochtain iomlán duit ar ghnéithe Legalesign:

  • Iarr ach na sonraí atá uait
  • Deiridhphointe amháin do gach rud
  • An chumhacht chéanna agus atá ag an aip gréasáin

Forbróirí TypeScript/JavaScript​

Smaoinigh ar an TS/JS SDK do chásanna coitianta, ach tugann foghlaim GraphQL rochtain iomlán duit ar an ardán. Déan comparáid idir SDK agus GraphQL.

Bain Triail as GraphQL Anois​

Tosaigh leis an Explorer GraphQL (éilíonn cuntas gníomhach).

Ligeann an Explorer duit:

  • Iarratais agus athruithe a thástáil
  • An scéim iomlán a bhrabhsáil
  • Dífhabhtú roimh chódú
eolas

Má tá tú logáilte isteach i Legalesign, tá an fíordheimhniú uathoibríoch.

Chun sampla oibre is lú a fháil, téigh chuig an Tús Tapúil.

leide

Faigh ceisteanna agus athruithe réidh trí iniúchadh a dhéanamh ar iarratais líonra i gcoincréid an aip gréasáin Legalesign.

Rochtain Clárúcháin​

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

MódClúdachCeannlíneIs Fearr do
OAuth 2.0Ach an fhoinse tacaíochta amháin (na hoibríochtaí eochair-API, ach gan generateComponentToken)Authorization: Bearer <access-token>Comhtháthaithe ag gníomhú ar son úsáideora Legalesign atá logáilte isteach agus a chuaigh i dtaithí
Eochair APIAch an fhoinse tacaíochta amháinAuthorization: Bearer <api-key>Uathoibriú taobh freastalaí agus sreafaí coitianta seolta/léite

Le OAuth 2.0, cláraigh cliant sa Tairseach Forbróra agus lean an treoir cliant OAuth.

Le fíordheimhniú eochair-API, cruthaigh eochair in ann GraphQL sa Tairseach Forbróra agus seiceáil na hoibríochtaí GraphQL tacaíochta do na ceisteanna agus athruithe tacaíochta.

Féach an treoir fíordheimhnithe le haghaidh sonraí breise.

Ag Úsáid Uirlis Códaithe AI?​

Má úsáideann tú Cursor, Claude, Windsurf, nó cúnamh AI eile, ceangail é leis an bhfreastalaí doiciméad Legalesign le haghaidh cúnamh comhthéacsacha agus tú ag códú. Féach Ceangail Do Uirlis AI.

Céimeanna Ar Aghaidh​

  1. Tosaigh leis an Tús Tapúil
  2. Cuir imeachtaí fíor-ama leis an Tús Tapúil Líne Websocket Fíor-ama
  3. Brabhsáil an scéim sa Explorer GraphQL
  4. Roghnaigh Fíordheimhniú OAuth 2.0 nó Eochair API do rochtain chláraithe
  5. Lean treoir: Node.js · C#
  6. Ceangail do uirlis AI le haghaidh cúnamh códúcháin comhthéacsacha

Tugann GraphQL duit an chumhacht chéanna agus atá ag aip gréasáin Legalesign — má tá sé indéanta ansin, tá sé indéanta leis an API freisin.