Sleamhnú go príomh-ábhar

Tús Tapa GraphQL

Taispeánann an tús tapa seo duit conas an GraphQL Explorer a úsáid chun:

  • a dhearbhú go bhfuil do chuntas ag obair le fiosrú simplí
  • do groupId agus templateId a fháil
  • doiciméad tástála a sheoladh leis na réimsí riachtanacha íosta
  • tuarascáil tasc a pholláil chun a dhearbhú go bhfuil cruthú doiciméad críochnaithe
  • an sreabhadh céanna a bhogadh isteach i Node.js, Python, nó C#

Roimh Fhís Amach​

Tá gá agat le:

  • Cuntas Legalesign ar féidir leat logáil isteach ann
  • Ar a laghad grúpa amháin agus teimpléad amháin i do chuntas
  • Eochair API - conas eochair API a fháil

Roghnaigh Fíordheimhniú​

Úsáideann an Explorer do sheisiún logáilte isteach Legalesign. I do chód féin, glacann GraphQL le heochracha API agus le tonnta rochtana OAuth 2.0.

MódCeanntáscIs Fearr do
Eochair APIAuthorization: Bearer <api-key>Uathoibriú ar thaobh an fhreastalaí agus sreafaí coitianta seolta/léithe. An bealach is tapúla chun tosú
OAuth 2.0Authorization: Bearer <access-token>Aipeanna a thógann tú do úsáideoirí d’eagraíocht, áit a shínigh gach duine isteach dá stádas féin. Féach Comhtháthú Cliant OAuth 2.0

Tugann an bheirt rochtain ar fheidhmiúlacht thacaithe den scéim GraphQL. Seiceáil na oibríochtaí GraphQL tacaáilte agus na scairdeanna fíordheimhnithe ar na leathanaigh tagartha chun a fheiceáil cén oibríochtaí is féidir leat a úsáid. Oibríonn na samplaí teanga sa tús tapa seo le haon cheann acu.

Oscail an GraphQL Explorer​

Téigh go dtí an GraphQL Explorer.

eolas

Má tá tú logáilte isteach i Legalesign, tá fíordheimhniú uathoibríoch san Explorer.

Cóipeáil agus greamaigh na fiosrúcháin thíos isteach sa GraphQL Explorer chun tosú. Níos déanaí, bainfear úsáid as an graphql céanna i do chód féin.

Fiosraigh Do Úsáideoir​

Tosaigh le fiosrú neamhchontúirteach chun a dhearbhú go bhfuil an Explorer ag obair:

query MyUser {
user {
id
firstName
lastName
email
}
}

Má éiríonn seo rathúil, tá do sheisiún Explorer ag obair agus tá tú réidh chun na IDanna riachtanacha a fháil le haghaidh seolta.

Fiosraigh Do Ghrúpaí​

An chéad rud eile, liostáil na grúpaí a bhaineann le do úsáideoir:

query MyGroups {
user {
memberConnection(first: 10) {
groupMembers {
group {
id
name
}
}
}
}
}

Cóipeáil an id don ghrúpa ónar mhaith leat a sheoladh. Seo do groupId.

Fiosraigh Teimpléid sa Ghrúpa Sin​

Anois fiosraigh na teimpléid sa ghrúpa sin:

query GroupTemplates($groupId: ID!) {
group(id: $groupId) {
id
name
templateConnection(first: 10) {
templates {
id
title
}
}
}
}

Úsáid na hathróga seo:

{
"groupId": "<your-group-id>"
}

Cóipeáil an id don teimpléad a bhfuil tú ag iarraidh a sheoladh. Seo do templateId.

Seol Do Chéad Doiciméad​

Greamaigh an athrú seo isteach san Explorer:

mutation SendDocument($input: DocumentSendSettingsInput!) {
send(input: $input)
}

Cuir na hathróga seo leis agus athraigh na luachanna ionaid:

{
"input": {
"groupId": "<your-group-id>",
"templateId": "<your-template-id>",
"title": "Test Document",
"recipients": [
{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"order": 0
}
]
}
}

Má tá an ionchur neamhbhailí, tugann an athrú earráid bailíochta láithreach ar ais.

Má éiríonn leis an athrú, tugann sé ID tasc ar ais. Próiseálann Legalesign na seolta go asíncrónach, mar sin tosaíonn an tasc an post seolta in ionad fanacht go ndéanfar an seachadadh a chríochnú.

Polláil An Tuarascáil Tasc​

leide

Tá polls go maith chun tosú. Don táirgeadh, is féidir leat aistriú chuig fo-scríbhinní chun dul chun cinn seolta a rianú i bhfíor-am ina ionad.

Tar éis send, bain úsáid as an ID tasc ar ais chun an fiosrú task a pholláil:

query GetTask($id: ID!) {
task(id: $id) {
data
report {
status
batchId
documents
errors
}
}
}

Úsáid na hathróga seo:

{
"id": "<task-id-from-send>"
}

Ceadaíonn an réimse report duit a dhearbhú cathain a críochnaíodh an cruthú doiciméad tar éis tasc asíncrónach a thosú tar éis seolta bailí.

Monatóireacht a dhéanamh ar report.status go dtí go sroicheann sé staid chríochnaithe:

  • Ciallaíonn COMPLETED go bhfuil cruthú doiciméad críochnaithe
  • Ciallaíonn FAILED nach raibh cruthú doiciméad rathúil

Fad is atá an tasc fós ag rith, d’fhéadfá stádas idirmheánacha a fheiceáil cosúil le PENDING nó READY.

Chun tosú agus le haghaidh protótíopa, is bealach simplí é task a pholláil chun dul chun cinn a sheiceáil. Don táirgeadh, déantar láithriú go fíor-ama a láimhseáil níos fearr le fo-scríbhinní.

Féach:

leide

Úsáid seoladh ríomhphoist faighteora fíor a bhfuil tú i mbun rialaithe agus tú ag tástáil, ionas gur féidir leat a dhearbhú go ndearnadh an seoladh mar a bhí beartaithe.

leide

Is féidir leat groupId agus templateId a bhaint amach freisin ó do threoracha dashbóird agus URLanna eagarthóra doiciméad - is iad sin an t-aon fhada alafhaimniú ina URLanna sin.

Bog go dtí an Cód​

Le haghaidh rochtana cláraithe, roghnaigh modh fíordheimhnithe ar dtús agus faigh comhartha nó eochair API. Féach Fíordheimhniú leis an API.

Fíordheimhnigh agus Déan Iarratas​

Nuair a bheidh do chomhartha nó eochair API agat, seol iarratas POST GraphQL le ceannlíne Authorization:

index.js
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);

Céimeanna Ar Aghaidh​

  1. Má theastaíonn socrú teanga ar leith uait, bain úsáid as Socrú Node.js nó Socrú C#
  2. Má tá tú ag iarraidh do theimpléad féin a chruthú ar dtús, lean Comhad a uaslódáil mar Theimpléad
  3. Léigh Doiciméad a Sheoladh don sampla iomlán cód Node.js
  4. Brabhsáil an tagairt athraithe seolta