Tòiseachadh Luath le GraphQL

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

• dearbhadh gu bheil do chunntas ag obair le ceist shìmplidh
• lorg do groupId agus templateId
• cuir thugad sgrìobhainn deuchainn leis na raointean as ìsle a tha riatanach
• sùil a chumail air aithisg an t-seirbheis gus dearbhadh gu bheil cruthachadh an sgrìobhainn air crìochnachadh
• gluasad an aon phròiseas gu Node.js, Python, no C#

Mus Tòisich Thu

Feumaidh tu:

• Cunntas Legalesign as urrainn dhut logadh a-steach e
• Co-dhiù aon bhuidheann agus aon teamplaid nad chunntas
• iuchair API - mar a gheibh thu iuchair API

Tagh Dearbhadh

Bidh an Explorer a’ cleachdadh do sheisean logaichte ann an Legalesign. Annta fhèin ann an còd agad, tha GraphQL a’ toirt taic do dhearbhadh SRP airson ruigsinneachd slabhraidh làn agus iuchraichean API airson fo-shreaptaiche taicichte.

Modh	Còmhdach	Ceann-clàr	As Fheàrr airson
SRP	Slabhraidh làn GraphQL	Authorization: Bearer <access-token>	Amalachadh làn
Iuchair API	A-mhàin fo-shreath taicichte	Authorization: Bearer <api-key>	Fèin-ghluasad taobh an t-seirbheis agus sruthan cumanta cuir/leugh

Tha an tòiseachadh luath seo a’ cleachdadh dearbhadh SRP anns na eisimpleirean cànain oir tha e ag obair air feadh slabhraidh làn GraphQL. Ma tha thu a’ cleachdadh iuchair Developer Portal API, thoir sùil air an iomradh API-key GraphQL agus na badges auth air duilleagan iomraidh.

Fosgail an GraphQL Explorer

Rach gu GraphQL Explorer.

fiosrachadh

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

Dèan lethbhreac agus pasgaidh na ceistean gu h-ìosal anns an GraphQL Explorer airson tòiseachadh. Nas fhaide air adhart, cleachdaidh tu an aon graphql anns a’ chòd agad fhèin.

Ceistean mu do neach-cleachdaidh

Tòisich le ceist shìmplidh gus dearbhadh gu bheil an Explorer ag obair:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Ma tha seo soirbheachail, tha an t-seisean Explorer agad ag obair agus tha thu deiseil airson na h-IDan a tha feumail airson cur fhaicinn.

Ceistean mu na Buidhnean agad

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

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

Dèan lethbhreac den id airson a’ bhuidheann às a bheil thu airson cur. Seo do groupId.

Ceistean mu na Teamplaidean anns a’ Bhuidhne 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 a tha thu airson a chur. Seo do templateId.

Cuir do Chiad Sgrìobhainn

Pasgaidh an ath atharrachadh dhan Explorer:

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

Cuir ris na caochladairean seo agus cuir nan luachan àite-batha:

{
  "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 cuir a-steach meallta, tillidh am mutation mearachd dearbhaidh gu sgiobalta.

Ma tha am mutation soirbheachail, tillidh e ID obair. Bidh Legalesign a’ giullachd chùisean cur gu mì-fhoirmeil, mar sin tha an obair ag tòiseachadh an obair cuir agus chan eil e a’ feitheamh ri lìbhrigeadh a chrìochnachadh.

Poll air Aithisg an Obair

comhairle

Tha polladh math airson tòiseachadh. Airson cinneasachadh, faodaidh tu gluasad gu fo-sgrìobhaidhean gus sùil a chumail air adhartas cuir ann an ùine fìor.

An dèidh send, cleachd an ID obrach air ais gus poll a dhèanamh air an task query:

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 cuin a tha cruthachadh an sgrìobhainn crìochnaichte às dèidh dhut cuir a chuir a-steach a’ tòiseachadh an obair async.

Cum sùil air report.status gus an ruig e staid crìochnachaidh:

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

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

Airson tòiseachadh agus deuchainn àbhaisteach, is e polladh task dòigh sìmplidh air adhartas a sgrùdadh. Airson cinneasachadh, tha naidheachdan ùine fìor nas fheàrr sa mhodh le fo-sgrìobhaidhean.

Faic:

• task query
• TaskReport
• Fuasglaidhean Mearachdan Dearbhaidh Cuir
• Eisimpleirean Fo-Sgrìobhaidh
• Sùil air Gnìomhan Cuir le Fo-Sgrìobhaidhean

comhairle

Cleachd seòladh puist-d làn fìor-shlàn dhut fhèin 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 URLan clàr-innse agus eag-shiostam foirmichean agad - ‘s iad coitcheann na fìor fhadaichean alphanumeric anns na URLan sin.

Gluais gu Còd

Airson ruigsinneachd phrògramach, tagh modh dearbhaidh an toiseach agus faigh token no iuchair API. Seall air Dearbhaich leis an API.

Dèan Dearbhadh agus Dèan Iarrtas

Aon uair ‘s gu bheil do theoken no iuchair API agad, cuir iarrtas POST GraphQL le ceann-clàr 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);

Nì a-nis

1. Ma tha feum agad air suidheachadh sònraichte do chànan, cleachd Suidheachadh Node.js no Suidheachadh C#
2. Ma tha thu airson do teamplaid fhèin a chruthachadh an toiseach, lean Luchdaich suas Faidhle mar Teamplaid
3. Leugh Cuir Sgrìobhainn airson an eisimpleir còd Node.js làn
4. Gabh sùil air an iomradh mutation send