Tòiseachadh Luath GraphQL

Tha an tòiseachadh luath seo a’ sealltainn dhut ciamar a chleachdas tu an GraphQL Explorer gus:

• dearbhadh gu bheil do chunntas ag obair le sgrùdadh sìmplidh
• faighinn a-mach do groupId agus templateId
• cur a-mach sgrìobhainn deuchainn leis na raointean minium riatanach
• rianachd aithisg an t-suidheachaidh gus dearbhadh gu bheil cruthachadh an sgrìobhaidh deiseil
• gluasad an aon shruth chun Node.js, Python, no C#

Mus Tòisich Thu

Feumaidh tu:

• Ruigsinneachd API air a chomasachadh airson do chunntas. Mura h-eil agad fhathast, faighnich dhuinn.
• Cunntas Legalesign as urrainn dhut logadh a-steach gu
• Co-dhiù aon bhuidheann agus aon shònrachaidh san chunntas agad

Tagh Dearbhadh-fhiosrachaidh

Cleachd an Explorer an seisean Legalesign a th’ agad logaichte a-steach mu thràth. Ann am brogramadh fhèin, tha GraphQL a’ toirt taic do dh’ùghdarrasachadh SRP airson ruigsinneachd iomlan air an schema agus iuchraichean API airson fo-shuidheachaidhean taicichte.

Modh	Sgaoileadh	Ceann-sgrìobh	As fheàrr airson
SRP	Schema GraphQL slàn	Authorization: Bearer <access-token>	Iomairtean làn-reachdail
Iuchra API	A-mhàin fo-suidheachadh taicichte	Authorization: Bearer <api-key>	Fèin-ghluasad air an taobh-frithealaiche agus sruthan cumanta cur/a-leughadh

Bidh an tòiseachadh luath seo a’ cleachdadh ùghdarrasachadh SRP anns na h-eisimpleirean cànain oir bidh e ag obair thairis air an schema GraphQL slàn. Ma tha thu a’ cleachdadh iuchra API am Portal Leasaiche, thoir sùil air an iomradh GraphQL airson iuchraichean API agus na bagaichean ùghdarras air duilleagan iomraidh.

Fosgail an GraphQL Explorer

Rach gu GraphQL Explorer.

fiosrachadh

Ma tha thu air logadh a-steach do Legalesign, tha an dearbhadh-fhiosrachaidh fèin-ghluasadach anns an Explorer.

Dèan lethbhreac agus cuir na ceistean gu h-ìosal dhan GraphQL Explorer gus tòiseachadh. Nas fhaide air adhart, cleachdaidh tu an aon graphql anns an àrainneachd chùdach agad fhèin.

Ceistich do neach-cleachdaidh

Tòisich le ceist gun chron gus dearbhadh gu bheil an Explorer ag obair:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Ma gheibh seo soirbheachas, tha seisean an Explorer ag obair agus tha thu deiseil airson na h-IDs a dh’ fheumas tu airson cur a-mach a lorg.

Ceistich do bhuidhnean

An ath rud, liostaich na buidhnean aig a bheil do neach-cleachdaidh ballrachd:

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

Dèan lethbhreac den id airson a’ bhuidheann bhon a bheil thu airson cur a-mach. Seo do groupId.

Ceistich Sònrachaidhean anns an Aon Bhuidheann

A-nis ceistich na sònrachaidhean anns an aon bhuidheann:

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 t-sònrachaidh a tha thu airson a chur a-mach. Seo do templateId.

Cuir a-mach do Chiad Sgrìobhainn

Cuir a-steach an tionndadh seo dhan Explorer:

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

Cuir ris na caochladairean seo agus cuir nan luachan àbhaisteach an àite:

{
  "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-inntrigue mì-laghail, thig mearachd dearbhaidh don tionndadh sa bhad.

Ma thèid an tionndadh gu soirbheachail, thig ID gnìomha. Bidh Legalesign a’ giullachd an cur gu asynchronous, agus mar sin tha an gnìomha a’ tòiseachadh an obair cur gu freagairteachd an àite feitheamh ri lìbhrigeadh.

Rianachd Aithisg an Gnìomha

comhairle

Tha rianachd freagarrach airson tòiseachadh. Airson cinneasachadh, faodaidh tu gluasad gu fo-sgrìobhaidhean gus leantainn air adhart an adhartas ann an ùine fhìor.

An dèidh send, cleachd ID an gnìomha a thàinig air ais gus an task query a rianachd:

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 dhut dearbhadh cuin a tha cruthachadh an sgrìobhainn deiseil às dèidh do ghnìomha async tòiseachadh le freagairteachadh dligheach.

Cum sùil air report.status gus an ruig e staid deireadh-lìn:

• COMPLETED a’ ciallachadh gu bheil cruthachadh an sgrìobhainn crìochnaichte
• FAILED a’ ciallachadh nach do chrìochnaich cruthachadh an sgrìobhainn gu soirbheachail

Fhad ‘s a tha an gnìomha fhathast ag obair, dh’ fhaodadh tu faicinn inbhean eadar-mheadhanach leithid PENDING no READY.

Airson tòiseachadh agus deuchainn, tha rianachd task na dhòigh sìmplidh airson sùil a chumail air adhartas. Airson cinneasachadh, tha ùrachaidhean anns an àm fhèin nas fheàrr air an làimhseachadh le fo-sgrìobhaidhean.

Faic:

• task query
• TaskReport
• Fuasglaidhean airson Mearachdan Dearbhaidh Cur
• Eisimpleirean Fo-sgrìobhaidh
• Leantainn air Gnìomhan Cur le Fo-sgrìobhaidhean

comhairle

Cleachd seòladh post-d fhìor an neach-fhaighinn a tha thu a’ riaghladh fhad ‘s a tha thu a’ deuchainn, gus an urrainn dhut dearbhadh gu bheil an cur air a chrìochnachadh mar a bha dùil.

comhairle

Faodaidh tu cuideachd groupId agus templateId a thoirt a-mach bho na ceanglaichean pàna-smachd agad agus an deasaiche foirmean - is iad seo an aon fhada alphanumeric anns na ceanglaichean sin.

Gluais gu Còd

Airson ruigsinneachd phrògramaichte, tagh modh dearbhadh-fiosrachaidh an toiseach agus faigh tèarainteachd no iuchra API. Faic Ùghdarraich leis an API.

Dèan Dearbhadh-fhiosrachaidh agus Dèan Iarrtas

Aon uair ‘s gu bheil do thèarainteachd no iuchra API agad, cuir iomradh POST GraphQL le ceann-sgrìobh 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);

Ceumannan an Ath-bhliadhna

1. Ma dh’ fheumas tu rèiteachadh sònraichte airson cànain, cleachd Rèiteachadh Node.js no Rèiteachadh C#
2. Ma tha thu airson do shònrachaidh fhèin a chruthachadh an toiseach, lean an luchdachadh suas faidhle mar shònrachadh
3. Leugh Cur Sgrìobhainn airson an eisimpleir còd Node.js iomlan
4. Brabhsadh air an iomradh tionndaidh cur