Tús Tapa le GraphQL

Taispeánann an tús tapa seo 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í is lú is gá
• tuarascáil thasc a pholláil chun a dhearbhú go bhfuil cruthú an doiciméid críochnaithe
• an sreabhadh céanna a aistriú go Node.js, Python, nó C#

Roimh duit Tosú

Tá uait:

• 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, tacaíonn GraphQL le fíordheimhniú SRP do rochtain iomlán ar an scéim, agus le heochracha API do shuirbhé tacaíochta.

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

Úsáideann an tús tapa seo fíordheimhniú SRP sna samplaí teanga toisc go n-oibríonn sé trasna ar an scéim iomlán GraphQL. Más eochair API ón Ionad Forbróra atá á húsáid agat, seiceáil an tagairt GraphQL le heochair API agus na boscaí féideartha ar na leathanaigh tagartha.

Oscail an GraphQL Explorer

Téigh go dtí an GraphQL Explorer.

eolas

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

Cóip agus greamaigh na fiosruithe 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.

Fiosraigh do Úsáideoir

Tosaigh le fiosrú neamh-dhíobhálach chun a dhearbhú go bhfuil an Explorer ag obair:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Má éiríonn leis seo, tá do sheisiún Explorer ag obair agus tá tú réidh chun na hIDanna a theastaíonn do sheoladh a fháil.

Fiosraigh do Ghrúpaí

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

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

Cóip an id don ghrúpa atá uait chun seoladh uaidh. 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
      }
    }
  }
}

Bain úsáid as na hathróga seo:

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

Cóip an id don teimpléad atá uait chun seoladh. 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 cuir in áit na luachanna sealadacha:

{
  "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 t-ionchur míchuí, tugann an athrú earráid bailíochdhána láithreach ar ais.

Má éiríonn leis an athrú, tugann sé ID tasc ar ais. Próiseálann Legalesign na seoltaí go asynchronach, mar sin tosnaíonn an tasc an post seolta sa phraiseach seachas fanacht go ndéanfar an seachadadh a chríochnú.

Polláil an Tuarascáil Tasc

leide

Is maith an rud é polláil chun tosú. Do tháirgeadh, is féidir leat lasc a dhéanamh go fo-scríbhinní chun dul chun cinn an tseolta a rianú i bhfíor-am ina áit.

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

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

Bain úsáid as 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 do sheoladh bailí tosú ar an tasc asynchronach.

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 ndearna cruthú an doiciméid críochnú go rathúil

Fad is atá an tasc fós ag rith, d'fhéadfá stádais idirghabhála a fheiceáil ar nós PENDING nó READY.

Chun tosú agus sampláil, is bealach simplí é polláil ar task chun dul chun cinn a sheiceáil. Do tháirgeadh, déantar nuashonruithe fíor-ama a láimhseáil níos fearr le fo-scríbhinní.

Féach:

• fiosrúchán tasc
• TaskReport
• Déan Fadhbanna ar Bhailíochtú Seolta
• Samplaí Fo-scríbhinní
• Rian a Chur ar Thascanna Seolta le Fo-scríbhinní

leide

Úsáid seoladh ríomhphoist fíor faighteora atá in do smacht agus tú ag tástáil, ionas gur féidir leat a dhearbhú gur críochnaigh an seoladh mar a bhíothas ag súil leis.

leide

Is féidir leat freisin groupId agus templateId a bhaint as do URLanna painéil agus eagarthóirí foirmlithe - is iad an t-aon chruinneas fada alfhánamhach sna URLanna sin.

Bog go Cód

Chun rochtain phrógrammhar, 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á an ticé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 Eile

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