Leum gu prìomh susbaint

Legalesign GraphQL API

Thathas a’ tabhann dà API aig Legalesign airson amalachadh soidhnidh-didseatach:

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

Tha am biadh seo a’ cuimseachadh air GraphQL. Bidh feum agad air eòlais air JSON agus eòlas bunaiteach air iarrtasan lìn.

Carson a Thaghas GraphQL?

Tha REST earbsach, eòlach, agus an làthair gus fuireach. Bidh GraphQL a’ toirt dòigh eadar-dhealaichte dhut smaoineachadh air an dàta a tharraing agus a chruthachadh. Anns a’ Legalesign, is e GraphQL an API àrd-inbhe — tha gach pàirt den àrd-ùrlar ri fhaighinn troimhe.

RESTGraphQL
Cinn-lathaIoma (/users, /contracts, msaa)Aon (/graphql)
Tarraing dàtaCeangailte ri gach ceann-lathaCeistean air am mìneachadh leis a’ chliant
Tarraing cus/no gu leòrCumantaNas lugha
DreachachadhDreachte (/v1/, /v2/)Gun dreach — chan bris na raointean ùra ceistean a bh’ ann roimhe
DearbhadhIuchair APISRP no fo-chruth iuchair API

Bidh GraphQL a’ toirt dhut cothrom iomlan air feartan Legalesign:

  • Iarr dìreach an dàta a dh’ fheumas tu
  • Cinn-latha singilte airson a h-uile càil
  • An aon chumhachd ris an aplacaid-lìn

Luchd-leasachaidh TypeScript/JavaScript

Beachdaich air an TS/JS SDK airson cùisean cumanta, ach bidh ionnsachadh GraphQL a’ toirt cothrom iomlan dhut air an àrd-ùrlar. Cuir an coimeas SDK an aghaidh GraphQL.

Dèan Deuchainn air GraphQL An-dràsta

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

Leigidh an Explorer leat:

  • Deuchainn a dhèanamh air ceistean agus atharrachaidhean
  • Brobhsadh air an sgèile iomlan
  • Fuasgladh fhaighinn ro bhith a’ còdachadh
fiosrachadh

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

Airson eisimpleir obrach beag as tràithe, thèid chun an Quickstart.

comhairle

Lorg ceistean agus atharrachaidhean deiseil le bhith a’ sgrùdadh iarrtasan lìonra ann an consol aplacaid-lìn Legalesign.

Cothrom Prògramaichte

Tha dà dhòigh dearbhaidh ri fhaighinn ann an GraphQL:

ModhCòmhdachCeann-sgrìobhadhAirson
SRPSgèile GraphQL slànAuthorization: Bearer <access-token>Amalachaidhean coileanta
Iuchair APIFo-chruth taic a-mhàinAuthorization: Bearer <api-key>fèin-ghluasad taobh an fhrithealaiche agus sruthan cumanta cur/aithris

Airson dearbhadh SRP, cuir fios gu taic Legalesign airson na teisteanasan agus mion-fhiosrachadh air do amalachadh fhaighinn.

Airson dearbhadh iuchair API, cruthaich iuchair GraphQL-taic anns an Portal Leasachaidh agus thoir sùil air an iomradh GraphQL airson iuchair API airson na ceistean agus atharrachaidhean taicichte.

Faic am 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 fhrithealaiche sgrìobhaidh Legalesign airson cuideachadh le co-theacsa fhad ‘s a bhios tu a’ còdachadh. Faic Ceangail Do Inneal AI.

Ceumannan Air Adhart

  1. Tòisich leis an Quickstart
  2. Cuir tachartasan beò adhartach ris leis an Real-Time Websocket Quickstart
  3. Rach air sgrùdadh air an sgèile sa GraphQL Explorer
  4. Tagh dearbhadh SRP no iuchair API airson cothrom prògramaichte
  5. Lean oideachadh: Node.js · C#
  6. Ceangail do inneal AI airson taic còdaidh le co-theacsa

Bidh GraphQL a’ toirt dhut an aon chumhachd ris an aplacaid-lìn Legalesign — ma dh’ fhaodas tu a dhèanamh an sin, gheibh thu e leis an API cuideachd.