Tòisichidh luath GraphQL
Tha an tòisichidh luath seo a’ sealltainn dhut mar a chleachdas tu Explorer GraphQL airson:
- dearbhadh gu bheil do chunntas ag obair le ceist shìmplidh
- lorg am
groupIdagus antemplateIdagad - sgrìobhadh sgrìobhainn deuchainn le na raointean as lugha a tha riatanach
- sgrùdadh aithisg an t-suidhe agam airson dearbhadh gu bheil cruthachadh sgrìobhainn deiseil
- gluasad an aon sruth ann an Node.js, Python, no C#
Mus tòisich thu
Feumaidh tu:
- Cunntas Legalesign as urrainn dhut logadh a-steach gu
- Co-dhiù aon buidheann agus aon teamplaid nad chunntas
- Iuchair API - mar a gheibh thu iuchair API
Tagh Fèin-phàipearachd
Bidh an Explorer a’ cleachdadh do sheisean Legalesign far an cuala tu a-steach. Ann an do chòd fhèin, gabhaidh GraphQL ri iuchraichean API agus tiodhlacan ruigsinneachd OAuth 2.0.
| Modh | Cinn-là | As Fheàrr airson |
|---|---|---|
| Iuchair API | Authorization: Bearer <api-key> | Fo-obraigen air an fhrithealaiche agus sruthan cumanta cur-a-steach/leughadh. An dòigh as luaithe gus tòiseachadh |
| OAuth 2.0 | Authorization: Bearer <access-token> | Iarrtasan a chruthaicheas tu airson luchd-cleachdaidh do bhuidheann, far a bheil gach neach a’ clàradh mar iad fhèin. Faic Integration Luchd-ceangail OAuth 2.0 |
Tha an dà chuid a’ toirt cothrom air fo-roinnean taicichte den schema GraphQL. Thoir sùil air na obrachaidhean GraphQL taiceil agus na bileagan dearbhaidh air na duilleagan tuairisgeulach gus faicinn dè na h-obrachaidhean as urrainn dhut a chleachdadh. Bidh na eisimpleirean cànain san tòisichidh luath seo ag obair leis an dà chuid.
Fosgail Explorer GraphQL
Rach gu GraphQL Explorer.
Ma tha thu air logadh a-steach do Legalesign, tha an dearbhadh fèin-ghluasadach anns an Explorer.
Dèan lethbhreac agus cuir na ceistean gu h-ìosal a-steach do GraphQL Explorer airson tòiseachadh. Nas fhaide air adhart, cleachdaidh tu an aon graphql anns an do chòd fhèin.
Ceist do Luchd-cleachdaidh
Tòisich le ceist neo-chiontach airson dearbhadh gu bheil an Explorer ag obair:
query MyUser {
user {
id
firstName
lastName
email
}
}
Ma thèid seo gu soirbheachail, tha do sheisean Explorer ag obair agus tha thu deiseil airson na h-IDs a dh'fheumas tu airson cur-a-steach a rannsachadh.
Ceist do Bhuidhean
An ath rud, liostaich na buidhnean air a bheil do luchd-cleachdaidh:
query MyGroups {
user {
memberConnection(first: 10) {
groupMembers {
group {
id
name
}
}
}
}
}
Dèan lethbhreac den id airson a’ bhuidheann a tha thu airson cur-a-steach bhuaithe. 'S e sin an groupId agad.
Ceist airson Teamplaidean anns a’ Bhuidhinn Sin
A-nis, ceist na teamplaidean anns a’ bhuidheann sin:
query GroupTemplates($groupId: ID!) {
group(id: $groupId) {
id
name
templateConnection(first: 10) {
templates {
id
title
}
}
}
}
Cleachd na caochladairean seo:
{
"groupId": "<your-group-id>"
}
Dèan lethbhreac den id airson an teamplaid as fheàrr leat a chur. 'S e sin an templateId agad.
Cuir do Chiad Sgrìobhainn
Cuir a-steach an atharrachaidh seo don Explorer:
mutation SendDocument($input: DocumentSendSettingsInput!) {
send(input: $input)
}
Cuir na caochladairean seo ris agus cuir nan àite na luachan àiteachaidh:
{
"input": {
"groupId": "<your-group-id>",
"templateId": "<your-template-id>",
"title": "Test Document",
"recipients": [
{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"order": 0
}
]
}
}
Ma tha an t-inntrigeadh mì-laghail, bidh am mutation a’ toirt air ais mearachd dearbhaidh sa bhad.
Ma bhios am mutation soirbheachail, bidh e a’ toirt air ais ID tasc. Bidh Legalesign a’ giullachd nan cur-a-steach gu asynchronous, mar sin bidh am tasc a’ tòiseachadh an obair cur-seòladh an àite a bhith a’ feitheamh ris an lìbhrigeadh.
Sgrùdadh do Aithisg Tasc
Tha sgrùdadh tric ceart airson tòiseachadh. Airson cinneasachadh, faodaidh tu gluasad gu fo-sgrìobhaidhean airson sùil a chumail air adhartas cur-a-steach ann an àm fìor.
An dèidh send, cleachd ID tasc a thig air ais airson sgrùdadh a dhèanamh air an task ceist:
query GetTask($id: ID!) {
task(id: $id) {
data
report {
status
batchId
documents
errors
}
}
}
Cleachd na caochladairean seo:
{
"id": "<task-id-from-send>"
}
Leigidh an raon report leat dearbhadh a dhèanamh nuair a tha cruthachadh an sgrìobhainn deiseil às dèidh do chur-siubhail dligheach tòiseachadh air an t-ascync tasc.
Cum sùil air report.status gus am ruig e staid dheireannach:
COMPLETED's e seo an comharra gu bheil cruthachadh an sgrìobhainn deiseilFAILED's e seo an comharra gu robh cruthachadh an sgrìobhainn gun soirbheachas
Fhad ‘s a tha an t-ascync tasc fhathast a’ ruith, faodaidh tu faicinn inbhean eadar-mheadhanach leithid PENDING no READY.
Airson tòiseachadh agus taisbeanadh phròtaip, tha sgrùdadh tric air task na dhòigh sìmplidh airson adhartas fhaicinn. Airson cinneasachadh, tha ùrachaidhean ann an àm fìor nas fheàrr le làimh dìreach le fo-sgrìobhaidhean.
Faic:
- ceist tasc
- TaskReport
- Fuasgladh duilgheadasan dearbhaidh cur-a-steach
- Eisimpleirean fo-sgrìobhaidhean
- Sùil air Gnìomhan Cur-a-steach le Fo-sgrìobhaidhean
Cleachd seòladh post-d fhaighinn fìor a tha thu anns an smachd fhad ’s a tha thu a’ deuchainn, gus am faigh thu dearbhadh gu bheil an cur-a-steach deiseil mar a bha dùil.
Faodaidh tu cuideachd groupId agus templateId a tharraing bho na h-URLan de do dashboard agus de eadar-theangairean formes - ’s e an aon rud fada alphanumeric anns na URLan sin.
Gluais gu Còd
Airson ruigsinneachd phrògramaichte, tagh modh dearbhaidh an toiseach agus faigh bileag no iuchair API. Faic Fèin-mhìneachadh leis an API.
Dearbhaich agus Dèan Iarrtas
Aon uair ‘s gu bheil do bhileag no iuchair API agad, cuir fios POST GraphQL le ceann-latha 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);
Ceumannan Eadar-dhealaichte
- Ma tha feum agad air rèiteachadh sònraichte airson cànan, cleachd Rèiteachadh Node.js no Rèiteachadh C#
- Ma tha thu airson do theamplaid fhèin a chruthachadh an toiseach, lean Luchdaich a-nuas Faidhle mar Theamplaid
- Leugh Cuir Sgrìobhainn airson eisimpleir chòd Node.js làn-ùine
- Brabhsair air a’ iomradh cònadh send mutation