API GraphQL Legalesign
Mae Legalesign yn cynnig dau API ar gyfer integreiddio arwydd-decyfrithiol:
- REST API - Dechrau cyflym, fformat traddodiadol
- GraphQL API - Pŵer llawn, mwy hyblyg
Mae’r canllaw hwn yn canolbwyntio ar GraphQL. Bydd arnoch angen gwybodaeth am JSON a phrofiad sylfaenol o geisiadau gwe.
Pam Dewis GraphQL?
Mae REST yn ddibynadwy, cyfarwydd, ac yma i aros. Mae GraphQL yn rhoi ffordd wahanol i chi feddwl am gael a siapio data. Yn Legalesign, GraphQL yw’r API dosbarth cyntaf — mae pob rhan o’r llwyfan ar gael drwyddi.
| REST | GraphQL | |
|---|---|---|
| Pwyntiau terfynol | Llawer (/users, /contracts, ac ati) | Un (/graphql) |
| Darllen data | Sefydlog fesul pwynt terfynol | Ymholiadau a nodir gan y cleient |
| Gormod/anhywir o ddarllen | Cyffredin | Yn cael ei leihau |
| Fersiwnio | wedi fersiynnu (/v1/, /v2/) | Heb fersiynau — ni fydd meysydd newydd yn torri ymholiadau presennol |
| Dilysu | Allwedd API | SRP neu is-set allwedd API |
Mae GraphQL yn rhoi mynediad cyflawn i nodweddion Legalesign:
- Gofynnwch am y data rydych chi ei angen yn unig
- Pwynt terfynol sengl ar gyfer popeth
- Yr un pŵer ag 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 llwyfan. Cyflwyno SDK vs GraphQL.
Rhowch Gynnig ar GraphQL Nawr
Dechreuwch gyda’r Archwiliwr GraphQL (mae cyfrif gweithredol yn ofynnol).
Mae’r Archwiliwr yn caniatáu i chi:
- Profi ymholiadau a newidynnau
- Pori’r schema gyflawn
- Datrys problemau cyn codio
Os ydych wedi mewngofnodi i Legalesign, mae’r dilysu yn awtomatig.
Ar gyfer enghraifft weithio syml gyntaf, ewch i’r Dechrau Cyflym.
Dewch o hyd i ymholiadau a newidynnau parod drwy archwilio’r ceisiadau rhwydwaith yn consol ap gwe Legalesign.
Mynediad Rhaglennu
Mae GraphQL yn cefnogi dau fodd dilysu:
| Modd | Cwmpas | Pennawd | Y gorau ar gyfer |
|---|---|---|---|
| SRP | Schema GraphQL llawn | Authorization: Bearer <access-token> | Integreiddiadau cyflawn |
| Allwedd API | Is-set a gefnogir yn unig | Authorization: Bearer <api-key> | Awtomeiddio ochr gweinydd a llifoedd cyffredin anfon/darllen |
Ar gyfer dilysu SRP, cysylltwch â cymorth Legalesign i gael y manylion a’r credydau ar gyfer eich integreiddiad.
Ar gyfer dilysu allwedd API, creu allwedd sydd wedi’i galluogi ar gyfer GraphQL yn y Porth Datblygwr a gwiriwch y cyfeirlyfr GraphQL allwedd API ar gyfer ymholiadau a newidynnau a gefnogir.
Gweler y canllaw dilysu am fwy o fanylion.
Defnyddio Offer Codio AI?
Os ydych yn defnyddio Cursor, Claude, Windsurf, neu gynorthwyydd AI arall, cysylltwch ef â gweinydd dogfennau Legalesign i gael 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 schema yn y Archwiliwr GraphQL
- Dewiswch dilysu SRP neu Allwedd API ar gyfer mynediad rhaglennu
- Dilynwch ganllaw: Node.js · C#
- Cysylltwch eich offer AI ar gyfer cymorth codio cyd-destunol
Mae GraphQL yn rhoi’r un pŵer ag ap gwe Legalesign — os gallwch ei wneud yno, gallwch ei wneud gyda’r API.