Dechrau Cyflym GraphQL
Mae'r dechrau cyflym hwn yn dangos i chi sut i ddefnyddio'r Archwiliwr GraphQL i:
- gadarnhau bod eich cyfrif yn gweithio gyda chwestiwn syml
- dod o hyd i'ch
groupIda'chtemplateId - anfon dogfen prawf gyda'r meysydd lleiaf sydd eu hangen
- holi'r adroddiad tasg i gadarnhau bod creu'r ddogfen wedi gorffen
- symud yr un llif i Node.js, Python, neu C#
Cyn I Chi Ddechrau
Mae arnoch angen:
- Cyfrif Legalesign y gallwch fewngofnodi iddo
- O leiaf un grŵp a un templed yn eich cyfrif
- Allwedd API - sut i gael allwedd API
Dewiswch Awdurdodiad
Mae'r Archwiliwr yn defnyddio eich sesiwn Legalesign wedi'ch mewngofnodi. Yn eich cod eich hun, mae GraphQL yn derbyn allweddi API a thocynnau mynediad OAuth 2.0.
| Modd | Pennawd | Yn addas ar gyfer |
|---|---|---|
| Allwedd API | Authorization: Bearer <api-key> | Awtomeiddio ar ochr y gweinydd a llifau cyffredin anfon/darllen. Y ffordd gyflymaf i ddechrau |
| OAuth 2.0 | Authorization: Bearer <access-token> | Apiau rydych yn eu hannog ar gyfer defnyddwyr eich sefydliad, lle mae pob person yn mewngofnodi fel eu hunain. Gweler Integreiddio Cleient OAuth 2.0 |
Mae'r ddau'n rhoi mynediad i is-set cefnogedig o'r schema GraphQL. Gwiriwch y gweithrediadau GraphQL sydd wedi'u cefnogi a'r bathodynnau awdurdodi ar y tudalennau cyfeirio i weld pa weithrediadau allwch eu defnyddio. Mae'r enghreifftiau iaith yn y dechrau cyflym hwn yn gweithio gyda'r naill neu'r llall.
Agorwch yr Archwiliwr GraphQL
Ewch i'r Archwiliwr GraphQL.
Os ydych wedi mewngofnodi i Legalesign, mae awdurdodiad yn digwydd yn awtomatig yn yr Archwiliwr.
Copïwch a gludwch y cwestiynau isod i'r Archwiliwr GraphQL i ddechrau. Yn ddiweddarach, byddwch yn defnyddio'r un graphql yn eich cod eich hun.
Cwestiynwch Eich Defnyddiwr
Dechreuwch gyda chwestiwn di-ffael i gadarnhau bod yr Archwiliwr yn gweithio:
query MyUser {
user {
id
firstName
lastName
email
}
}
Os yw hyn yn llwyddo, mae eich sesiwn Archwiliwr yn gweithio ac rydych yn barod i edrych i fyny'r IDau sydd eu hangen arnoch ar gyfer anfon.
Cwestiynwch Eich Grwpiau
Yna, rhestrwch y grwpiau y mae'ch defnyddiwr yn perthyn iddynt:
query MyGroups {
user {
memberConnection(first: 10) {
groupMembers {
group {
id
name
}
}
}
}
}
Copïwch y id ar gyfer y grŵp rydych am anfon oddi wrtho. Dyma'ch groupId.
Cwestiynwch Dempledi Yn Y Grŵp Hynny
Nawr, cwestiynwch y templedi yn y grŵp hwnnw:
query GroupTemplates($groupId: ID!) {
group(id: $groupId) {
id
name
templateConnection(first: 10) {
templates {
id
title
}
}
}
}
Defnyddiwch y newidiolion hyn:
{
"groupId": "<your-group-id>"
}
Copïwch y id ar gyfer y templed rydych am anfon. Dyma'ch templateId.
Anfonwch Eich Dogfen Gyntaf
Gludwch y newidyn hwn i'r Archwiliwr:
mutation SendDocument($input: DocumentSendSettingsInput!) {
send(input: $input)
}
Ychwanegwch y newidiolion hyn a disodli'r gwerthoedd llethrau:
{
"input": {
"groupId": "<your-group-id>",
"templateId": "<your-template-id>",
"title": "Test Document",
"recipients": [
{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"order": 0
}
]
}
}
Os yw'r mewnbwn yn annilys, mae'r newidyn yn dychwelyd gwall dilysu ar unwaith.
Os yw'r newidyn yn llwyddo, mae'n dychwelyd ID tasg. Mae Legalesign yn prosesu anfoniadau'n asyncronig, felly mae'r tasg yn cychwyn y gwaith anfon yn hytrach na disgwyl i'r anfon orffen.
Holi Adroddiad Tasg
Mae holi yn iawn i ddechrau. Ar gyfer cynhyrchu, gallwch newid i tanysgrifiadau i olrhain cynnydd anfon mewn amser real yn lle hynny.
Ar ôl send, defnyddiwch y ID tasg a dderbyniwyd i holi'r cwestiwn task:
query GetTask($id: ID!) {
task(id: $id) {
data
report {
status
batchId
documents
errors
}
}
}
Defnyddiwch y newidiolion hyn:
{
"id": "<task-id-from-send>"
}
Mae'r maes report yn caniatáu i chi gadarnhau pryd mae creu dogfen wedi gorffen ar ôl i anfon dilys ddechrau'r dasg asyncronig.
Monitro report.status nes ei fod yn cyrraedd cyflwr terfynol:
COMPLETEDyn golygu bod creu'r ddogfen wedi gorffenFAILEDyn golygu nad oedd creu'r ddogfen yn llwyddo'n llawn
Tra bod y dasg yn dal i redeg, efallai y byddwch yn gweld statwsau canolradd megis PENDING neu READY.
Ar gyfer dechrau a phrototeipio, mae holi task yn ffordd syml o wirio cynnydd. Ar gyfer cynhyrchu, mae diweddariadau amser real yn cael eu trin yn well gyda tanysgrifiadau.
Gweler:
- cwestiwn tasg
- TaskReport
- Datrys Gwallau Dilysu Anfon
- Enghreifftiau Tanysgrifiad
- Olrhain Tasgau Anfon gyda Thanysgrifiadau
Defnyddiwch gyfeiriad e-bost derbynnydd go iawn yr ydych yn ei reoli wrth brofi, fel y gallwch gadarnhau bod yr anfon wedi'i gwblhau fel disgwyl.
Gallwch hefyd echdynnu groupId a templateId o URLs eich dangosfwrdd a golygydd templedi - nhw yw'r unig rifau hir alffaniwmerig yn y URLs hynny.
Symud i'r Cod
Ar gyfer mynediad rhaglenol, dewiswch gyntaf fodd awdurdodi a chael tocyn neu allwedd API. Gweler Awdurdodi gyda'r API.
Awdurdodi a Gwneud Cais
Unwaith y byddwch wedi'ch tocyn neu allwedd API, anfonwch gais POST GraphQL gyda phenawd Authorization:
const GRAPHQL_ENDPOINT = 'https://graphql.uk.legalesign.com/graphql';
const TOKEN = '<token-or-api-key>';
async function graphql(token, query, variables = {}) {
const response = await fetch(GRAPHQL_ENDPOINT, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
},
body: JSON.stringify({ query, variables })
});
return response.json();
}
async function main() {
const result = await graphql(TOKEN, `
query {
user {
id
firstName
lastName
email
}
}
`);
console.log(JSON.stringify(result, null, 2));
}
main().catch(console.error);
Camau Nesaf
- Os oes angen gosodiad penodol iaith arnoch, defnyddiwch Gosodiad Node.js neu Gosodiad C#
- Os ydych am greu eich templed eich hun yn gyntaf, dilynwch Llwytho Ffeil fel Templed
- Darllenwch Anfon Dogfen am yr enghraifft godd Node.js lawn
- Poriwch y cyfeirlyfr newidyn anfon