API Legalesign GraphQL
I ddefnyddio'r API Legalesign mae angen i chi gysylltu â ni i gael cymeradwyaeth i ddefnyddio'r API ar gyfer eich cyfrif.
Mae Legalesign yn cynnig dau API ar gyfer integreiddio llofnodi electronig:
- REST API - Dechrau cyflym, fformat traddodiadol
- GraphQL API - Pwer llawn, mwy hyblyg
Mae'r canllaw hwn yn canolbwyntio ar GraphQL. Bydd angen i chi gael gwybodaeth am JSON a phrofiad sylfaenol o wneud ceisiadau gwe.
Pam Ddewis GraphQL?
Mae REST yn ddibynadwy, yn gyfarwydd, ac yn aros. Mae GraphQL yn rhoi ffordd wahanol i chi feddwl am nôl a siapio data. Yn Legalesign, mae GraphQL yn API dosbarth cyntaf — mae pob rhan o’r platfform ar gael drwyddo.
| REST | GraphQL | |
|---|---|---|
| Pwyntiau terfynol | Amrywiol (/users, /contracts, ac ati) | Un (/graphql) |
| Darganfod data | Sefydlog fesul pwynt terfynol | Cwestiynau a ddiffinir gan y cleient |
| Gormod/anghywir ddarganfod | Cyffredin | Lleihau |
| Fersiynau | Fersiynedig (/v1/, /v2/) | Heb fersiwn — nid yw meysydd newydd yn torri cwestiynau presennol |
| Dilysu | Allwedd API | SRP neu is-set o allwedd API |
Mae GraphQL yn rhoi mynediad cyflawn i nodweddion Legalesign:
- Gofynnwch am y data rydych ei angen yn unig
- Un pwynt terfynol ar gyfer popeth
- Yr un pŵer ag ap gwe
Datblygwyr TypeScript/JavaScript
Ystyriwch y SDK TS/JS ar gyfer achosion defnydd cyffredin, ond mae dysgu GraphQL yn rhoi mynediad llawn i’r platfform i chi. Cymharwch y SDK â GraphQL.
Rhowch gynnig ar GraphQL Nawr
Dechreuwch gyda’r Explorer GraphQL (mae angen cyfrif gweithredol).
Mae’r Explorer yn caniatáu i chi:
- Profi cwestiynau a newidiadau
- Porwch y schema gyflawn
- Datrys problemau cyn codio
Os ydych wedi mewngofnodi i Legalesign, mae’r dilysu yn awtomatig.
Am enghraifft syml o'r cyntaf sy'n gweithio, ewch i'r Dechrau Cyflym.
Darganfyddwch gwestiynau a newidiadau parod drwy archwilio ceisiadau rhwydwaith yn nghonsole app gwe Legalesign.
Mynediad Rhaglennu
Mae GraphQL yn cefnogi dau fodd dilysu:
| Modd | Cynnwys | Penawd | Gorau ar gyfer |
|---|---|---|---|
| SRP | Schema GraphQL llawn | Authorization: Bearer <access-token> | Integreiddiadau cyflawn |
| Allwedd API | Is-set cefnogol yn unig | Authorization: Bearer <api-key> | Awtomatwaith ochr gweinydd a llifau anfon/darllen cyffredin |
Ar gyfer dilysu SRP, cysylltwch â chefnogaeth Legalesign i gael y manylion a'r cymwysterau ar gyfer eich integreiddiad.
Ar gyfer dilysu allwedd API, creu allwedd wedi'i alluogi ar gyfer GraphQL yn y Porth Datblygwr a gwiriwch y cyfeiriad API-key GraphQL am gwestiynau a newidiadau sydd ar gael.
Gweler y canllaw dilysu am fanylion mwy.
Yn Defnyddio Offer Codio AI?
Os ydych yn defnyddio Cursor, Claude, Windsurf, neu gynorthwyydd AI arall, cysylltwch ef â gweinydd dogfennau Legalesign ar gyfer help 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 yr Explorer GraphQL
- Dewiswch dilysu SRP neu API-key ar gyfer mynediad rhaglennu
- Dilynwch doriaduron: Node.js · C#
- Cysylltwch eich offer AI am gymorth 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.