Legalesign GraphQL API
Mae Legalesign yn cynnig dau API ar gyfer integreiddio llofnod electronig:
- REST API - Dechrau cyflym, fformat traddodiadol
- GraphQL API - Pwer llawn, mwy hyblyg
Mae'r canllaw hwn yn canolbwyntio ar GraphQL. Bydd angen gwybodaeth am JSON a phrofiad sylfaenol mewn ceisiadau gwe arnoch.
Pam Dewis GraphQL?
Mae REST yn ddibynadwy, cyfarwydd, ac yma i aros. Mae GraphQL yn rhoi ffordd wahanol i chi feddwl am nôl a siapio data. Yn Legalesign, GraphQL yw'r API dosbarth cyntaf — mae pob rhan o’r platfform ar gael drwyddi.
| REST | GraphQL | |
|---|---|---|
| Pwyntiau terfynol | Lluosog (/users, /contracts, ac ati) | Unigol (/graphql) |
| Nôl data | Sefydlog fesul pwynt terfynol | Ymholiadau a ddiffinir gan y cleient |
| Gormod/annigon o ddata | Cyffredin | Llai |
| Fersiwnio | Wedi’i fersiynu (/v1/, /v2/) | Heb fersiwn — ni fydd meysydd newydd yn torri ymholiadau presennol |
| Dilysu | Allwedd API | OAuth 2.0 neu allwedd API (yr un is-set cefnogol) |
Mae GraphQL yn rhoi mynediad llawn i nodweddion Legalesign:
- Gofynnwch am y data rydych ei angen yn unig
- Un pwynt terfynol ar gyfer popeth
- Yr un pŵer â’r ap gwe
Datblygwyr TypeScript/JavaScript
Ystyriwch y TS/JS SDK ar gyfer achosion defnydd cyffredin, ond mae dysgu GraphQL yn rhoi mynediad llawn i’r platfform. Cymharwch SDK vs GraphQL.
Profwch GraphQL Nawr
Dechreuwch gyda'r Archwilydd GraphQL (mae angen cyfrif gweithredol).
Mae'r Archwilydd yn eich galluogi i:
- Prawf ymholiadau a throsglwyddiadau
- Pori’r cynllun llawn
- Dadfygio cyn codio
Os ydych wedi mewngofnodi i Legalesign, mae dilysu’n awtomatig.
Ar gyfer enghraifft weithredol gyntaf lleiaf, ewch i’r Dechrau Cyflym.
Darganfyddwch ymholiadau a throsglwyddiadau parod trwy archwilio ceisiadau rhwydwaith yng nghonsol ap gwe Legalesign.
Mynediad Rhaglennu
Mae GraphQL yn cefnogi dau fodd dilysu:
| Modd | Cwmpas | Pennawd | Gorau ar gyfer |
|---|---|---|---|
| OAuth 2.0 | Dim ond yr is-set cefnogol (gweithrediadau allwedd-API, heblaw generateComponentToken) | Authorization: Bearer <access-token> | Integreiddiadau sy’n gweithredu ar ran defnyddiwr Legalesign, sy’n mewngofnodi ac yn rhoi caniatâd |
| Allwedd API | Dim ond yr is-set cefnogol | Authorization: Bearer <api-key> | Awtomeiddio ochr y gweinydd a llifau anfon/darllen cyffredin |
Ar gyfer OAuth 2.0, cofrestrwch gwsmer yn y Porth Datblygwr a dilynwch y canllaw cwsmer OAuth.
Ar gyfer dilysu allwedd-API, creu allwedd sydd wedi’i galluogi ar gyfer GraphQL yn y Porth Datblygwr a gwiriwch y gweithrediadau GraphQL a gefnogir ar gyfer ymholiadau a throsglwyddiadau a gefnogir.
Gweler y canllaw dilysu am ragor o fanylion.
Yn Defnyddio Offer Codio AI?
Os ydych yn defnyddio Cursor, Claude, Windsurf, neu gynorthwyydd AI arall, cysylltwch ef â gweinydd dogfennau Legalesign ar gyfer cymorth cyd-destun wrth godio. Gweler Cysylltu Eich Offer AI.
Camau Nesaf
- Dechreuwch gyda’r Dechrau Cyflym
- Ychwanegwch ddigwyddiadau amser-real gyda’r Dechrau Cyflym Websocket Amser Real
- Archwiliwch y cynllun yn yr Archwilydd GraphQL
- Dewiswch OAuth 2.0 neu ddilysu allwedd API ar gyfer mynediad rhaglennu
- Dilynwch werslyfr: Node.js · C#
- Cysylltwch eich offer AI ar gyfer cymorth codio cyd-destunol
Mae GraphQL yn rhoi’r un pŵer â’r ap gwe Legalesign — os gallwch ei wneud yno, gallwch ei wneud gyda’r API.