Tús Tapa le GraphQL

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

• a dheimhniú go bhfuil do chuntas ag obair le ceist shimplí
• do groupId agus templateId a fháil
• doiciméad tástála a sheoladh leis na cúinsí íosta riachtanacha
• tuairisc an tasc a pholláil chun a dhearbhú gur críochnaigh cruthú an doiciméid
• an sreabhadh céanna a bhogadh isteach i Node.js, Python, nó C#

Roimh Thosú

Tá de dhíth ort:

• Rochtain API cumasaithe do do chuntas. Mura bhfuil agat fós, déan teagmháil linn.
• Cuntas Legalesign inar féidir leat logáil isteach
• Ar a laghad grúpa amháin agus teimpléad amháin i do chuntas

Roghnaigh Fíordheimhniú

Úsáideann an Explorer do shesún Legalesign logáilte isteach. I do chód féin, tacaíonn GraphQL le fíordheimhniú SRP le rochtain iomlán ar an scéim agus le heochracha API do fhoinse áirithe tacaíochta.

Mód	Clúdach	Ceannlíne	Is fearr do
SRP	Scéim iomlán GraphQL	Authorization: Bearer <access-token>	Idirghníomhachtaí iomlána
Eochair API	Foinsí tacaíochta amháin	Authorization: Bearer <api-key>	Uathoibriú taobh freastalaí agus sreafaí coitianta seolta/ léitheoireachta

Úsáideann an tús tapa seo fíordheimhniú SRP sna samplaí teanga toisc go n-oibríonn sé ar fud na scéime iomláine GraphQL. Má tá eochair API ó Developer Portal á úsáid agat, seiceáil an Tagairt GraphQL do eochair API agus na bheartais fíordheimhnithe ar leathanaigh tagartha.

Oscail an GraphQL Explorer

Téigh chuig an GraphQL Explorer.

eolas

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

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

Ceistigh do Úsáideoir

Tosaigh le ceist neamhchontúirteach chun a dheimhniú go bhfuil an Explorer ag obair:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Má éiríonn leis seo, tá d’fheidhmiúlacht Explorer ag obair agus tá tú réidh chun na IDanna atá uait le haghaidh seolta a fháil.

Ceistigh do Ghrúpaí

Ansin, liostaigh na grúpaí ina mbaineann do úsáideoir:

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

Cóipeáil an id don ghrúpa ar mhaith leat seoladh uaidh. Sin é do groupId.

Ceistigh Teimpléid sa Ghrúpa sin

Anois ceistigh 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 ar mhaith leat seoladh uaidh. Sin é 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 cuir in áit na luachanna ionduchtaithe:

{
  "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í, filleann an athrú earráid bailíochta láithreach.

Má éiríonn leis an athrú, tugtar ID tasc ar ais duit. Próiseálann Legalesign na seolta go neamhshioncronach, mar sin cuireann an tasc tús leis an bpost seolta in ionad fanacht leis an seachadadh a chríochnú.

Polláil Tuairisc an Tasc

leide

Tá polláil oiriúnach chun tosú. Do tháirgeadh, is féidir leat aistriú go dtí síntiúsanna chun dul chun cinn an tseolta a rianú i bhfíor-am ina ionad.

Tar éis send, bain úsáid as ID an tasc ar ais chun an t- 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>"
}

Ligeann an réimse report duit a dhearbhú cathain a chríochnaigh cruthú an doiciméid tar éis tasc asynchronaíoch bailí a thosú.

Féach ar report.status go dtí go sroicheann sé stádas deiridh:

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

Fad a bhíonn an tasc fós ar siúl, d’fhéadfá stádais idirghabhála a fheiceáil ar nós PENDING nó READY.

Le haghaidh tosaithe agus protaipeála, is bealach simplí é an task a pholláil chun dul chun cinn a sheiceáil. Do tháirgeadh, déantar nuashonruithe fíor-ama a láimhseáil níos fearr le síntiúsanna.

Féach cuir i gcás:

• cÓIRSTE TASC
• TuairiscTasc
• Trostú ar Bailíochtú Shendála
• Samplaí Síntiúsanna
• Rianáil Tascanna Seolta le Síntiúsanna

leide

Úsáid seoladh ríomhphoist faighteora fíor atá faoi do smacht agus tú ag tástáil, ionas gur féidir leat a dhearbhú gur críochnaíodh an seoladh mar gheall ar an beart.

leide

Is féidir leat freisin groupId agus templateId a bhaint as do dashbord agus na URLanna eagarthóra foirmeacha - is iad sin an t-aon chaighdeán fada uimhriúil sna URLanna sin.

Bog go Cód

Le rochtain clárúcháin, roghnaigh mód fíordheimhnithe ar dtús agus faigh ticéad nó eochair API. Féach Fíordheimhniú leis an API.

Fíordheimhniú agus Iarratas a Dhéanamh

Nuair atá do thicéad nó eochair API agat, seol iarratas GraphQL POST 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á tá socrú teanga áirithe uait, bain úsáid as Socrú Node.js nó Socrú C#
2. Má tá tú ag iarraidh teimpléad féin a chruthú ar dtús, lean Uaslódáil Comhad mar Theimpléad
3. Léigh Seol Doiciméad don sampla iomlán cód Node.js
4. Brabhsáil an tagairt athraithe seolta