Sleamhnú go príomh-ábhar

API GraphQL Legalesign

Tugann Legalesign dhá API le haghaidh comhtháthú síniú leictreonach:

  • REST API - Tús tapa, foirmseán traidisiú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.

Cén Fáth Roghnú GraphQL?

Tá REST iontaofa, compordach, agus anseo le fanacht. Tugann GraphQL bealach eile duit chun smaoineamh ar íoslódáil agus cruthú sonraí. Ag Legalesign, is é GraphQL an API ar an gcéad chéim — tá gach cuid den ardán ar fáil tríd.

RESTGraphQL
DeiridhphointíIlghnéitheach (/users, /contracts, srl.)Aonair (/graphql)
Faigh sonraíCinniúnaithe in aghaidh deireadhphointeIarratais sainmhínithe teangailte
Iomhánna rómhór/níos lú sonraíCoitiantaLaghdaítear
LeaganúLeagananna (/v1/, /v2/)Gan leagan – ní bhriseann réimsí nua na fiosruithe atá ann
FíordheimhniúEochair APISRP nó fo-phioc eochair API

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

  • Iarr ar na sonraí atá uait amháin
  • Deiridhphointe aonair don uile rud
  • Cumhacht chéanna leis an aip gréasáin

Forbróirí TypeScript/JavaScript

Smaoinigh ar an TS/JS SDK le haghaidh cásanna coitianta, ach tugann foghlaim GraphQL rochtain iomlán duit ar an ardán. Comparáid idir SDK agus GraphQL.

Bain Triail as GraphQL Anois

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

Ligeann an Explorer duit:

  • Triail a bhaint as fiosruithe agus modhnuithe
  • Brabhsáil an scéim iomlán
  • Díbearródh roimh chódú
eolas

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

Le sampla oibre íosta, téigh chuig an Tús Tapa.

leide

Faigh fiosruithe agus modhnuithe réamhullmhaithe tríd an iarratas líonra a iniúchadh i gcoinéal aip gréasáin Legalesign.

Rochtain Chláraitheach

Tacaíonn GraphQL le dhá mhodh fíordheimhniú:

MódClúdachCeanntáscIs Fearr do
SRPScéim iomlán GraphQLAuthorization: Bearer <access-token>Comhtháthuithe iomlána
Eochair APIFo-phioc tacaíochta amháinAuthorization: Bearer <api-key>Uathoibriú freastalaí agus sreafaí coitianta seolta/léitheoireachta

Le haghaidh fíordheimhniú SRP, déan teagmháil le tacaíocht Legalesign chun an chreidiúnacht agus sonraí do do chomhtháthaithe a fháil.

Le haghaidh fíordheimhniú ar eochair API, cruthaigh eochair atá cumasaithe le GraphQL sa Tollán Forbróra agus féach an tagairt eochair API GraphQL do na fiosruithe agus modhnuithe tacaíochta.

Féach an treoir fíordheimhniú le haghaidh tuilleadh sonraí.

Ag Úsáid Uirlis Cóid AI?

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

Céimeanna Eile

  1. Tosaigh leis an Tús Tapa
  2. Cuir eachtraí fíor-ama leis an Tús Tapa Websocket Fíor-ama
  3. Iniúch an scéim san GraphQL Explorer
  4. Roghnaigh Fíordheimhniú SRP nó eochair API le haghaidh rochtain cláraitheach
  5. Lean rang teagaisc: Node.js · C#
  6. Ceangail do uirlis AI le haghaidh cúnamh códaithe comhthéacsúil

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