Sleamhnú go príomh-ábhar

API Legalesign GraphQL

Teastaíonn cead rochtana API

Chun API Legalesign a úsáid ní mór duit déan teagmháil linn chun úsáid API a cheadú do do chuntas.

Tairgeann Legalesign dhá API chun comhtháthú síniú leictreonach a dhéanamh:

  • REST API - Tosú tapa, formáid thraidisiúnta
  • GraphQL API - Cumhacht iomlán, níos ilúsáidte

Díreoidh an treoir seo ar GraphQL. Beidh eolas agat ar JSON agus ar thaithí bhunúsach ar iarratais gréasáin.

Cén Fáth GraphQL a Roghnú?

Tá REST iontaofa, eolach, agus le fanacht. Tugann GraphQL bealach difriúil duit smaoineamh ar fhaisnéis a fháil agus a mhúnlú. Ag Legalesign, is é GraphQL an API den chéad scoth — tá gach cuid den ardán ar fáil trína.

RESTGraphQL
DeiridhphointíIlchodacha (/users, /contracts, srl.)Aonair (/graphql)
Fáil sonraíSainithe de réir ceann deiridhphointíIarratais sainmhínithe ag an gcustaiméir
Ró-shuíomh / faoi-shuíomh sonraíCoitiantaLaghdaithe
LeaganúLeaganaithe (/v1/, /v2/)Gan leagan — ní bhriseann réimsí nua na n-iarratas atá ann cheana
FíordheimhniúEochair APISRP nó fo-sraith eochair API

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

  • Iarr ach ar na sonraí a theastaíonn uait
  • Aon deiridhphointe le haghaidh gach rud
  • An chumhacht chéanna leis 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. Compare SDK vs GraphQL.

Bain Triail as GraphQL Anois

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

Ligeann an Explorer duit:

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

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

Le sampla nua-aimseartha oibre ar a laghad, téigh chuig an Tosaithe Tapa.

leide

Faigh iarratais agus athruithe réidh trí fhiosrú iarratais líonra i gcoimisiúin an aip gréasáin Legalesign.

Rochtain Chláraitheach

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

MódClúdachCeanntáscIs Fearr le haghaidh
SRPScéim iomlán GraphQLAuthorization: Bearer <access-token>Comhtháthuithe iomlána
Eochair APIFo-shraith tacaíochta amháinAuthorization: Bearer <api-key>Uathoibriú taobh freastalaí agus sreafaí coitianta seol/admháil

Le fíordheimhniú SRP, déan teagmháil le tacaíocht Legalesign chun na cáilíochtaí agus sonraí a fháil do do chomhtháthú.

Le fíordheimhniú eochair API, cruthaigh eochair cumasaithe GraphQL i Ionad Forbróra agus féach an tagairt eochair API GraphQL do na hiarratais agus athruithe tacaithe.

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

Ag Úsáid Uirlis Cóid AI?

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

Céimeanna Seo a Leanas

  1. Tosaigh leis an Tosaithe Tapa
  2. Cuir himeachtaí fíor-ama leis an Tosaithe Tapa Websocket Fíor-ama
  3. Iniúch an scéim sa GraphQL Explorer
  4. Roghnaigh fíordheimhniú SRP nó eochair API do rochtain chláraitheach
  5. Lean treoir: Node.js · C#
  6. Ceangail d’uirlis AI le haghaidh cabhair códaithe comhthéacsbhunaithe

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