Cyflymder GraphQL

Mae'r cyflymder hwn yn dangos i chi sut i ddefnyddio'r Archwiliwr GraphQL i:

• gadarnhau bod eich cyfrif yn gweithio gyda chwestiwn syml
• dod o hyd i'ch groupId a'ch templateId
• anfon dogfen brawf gyda'r meysydd lleiafsaf sydd eu hangen
• arolwg adroddiad y dasg i gadarnhau bod creu'r ddogfen wedi cwblhau
• symud yr un llif i Node.js, Python, neu C#

Cyn i Chi Ddechrau

Mae arnoch angen:

• Cyfrif Legalesign y gallwch fewngofnodi iddo
• O leiaf un grŵp a un templed yn eich cyfrif
• Allwedd API - sut i gael allwedd API

Dewiswch Awdurdodiad

Mae'r Archwiliwr yn defnyddio eich sesiwn Legalesign wedi'i fewngofnodi. Yn eich cod eich hun, mae GraphQL yn cefnogi awdurdodiad SRP ar gyfer mynediad i'r amserlen gyflawn a allweddi API ar gyfer is-set sy'n cael ei chefnogi.

Modd	Gorwedd	Penawd	Gorau ar gyfer
SRP	Amserlen lawn GraphQL	Authorization: Bearer <access-token>	Integreiddiadau cyflawn
Allwedd API	Dim ond is-set sy'n cael ei chefnogi	Authorization: Bearer <api-key>	Awtomeiddio ochr gweinydd a llifoedd anfon/darllen cyffredin

Mae'r cyflymder hwn yn defnyddio awdurdodiad SRP yn y enghreifftiau iaith oherwydd ei fod yn gweithio ar draws yr amserlen lawn GraphQL. Os ydych yn defnyddio allwedd API Portal Datblygwr, gwiriwch y cyfeirnod GraphQL allwedd API a'r bathodynnau awdurdodiad ar dudalennau cyfeirnod.

Agorwch yr Archwiliwr GraphQL

Ewch i'r Archwiliwr GraphQL.

gwybodaeth

Os ydych wedi mewngofnodi i Legalesign, mae awdurdodiad yn awtomatig yn yr Archwiliwr.

Copïwch a gludwch y cwestiynau isod i mewn i'r Archwiliwr GraphQL i ddechrau. Yn ddiweddarach, byddwch yn defnyddio'r un graphql yn eich cod eich hun.

Cwestiynwch Eich Defnyddiwr

Dechreuwch gyda chwestiwn di-niwed i gadarnhau bod yr Archwiliwr yn gweithio:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Os bydd hyn yn llwyddo, mae eich sesiwn Archwiliwr yn gweithio a rydych yn barod i edrych i fyny'r IDau sydd eu hangen ar gyfer anfon.

Cwestiynwch Eich Grwpiau

Yn nes ymlaen, rhestrwch y grwpiau y mae eich defnyddiwr yn perthyn iddynt:

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

Copïwch yr id ar gyfer y grŵp yr ydych am anfon ohono. Dyma yw eich groupId.

Cwestiynwch Dempledi yn y Grŵp Hynny

Nawr cwestiynwch y templedi yn y grŵp hwnnw:

query GroupTemplates($groupId: ID!) {
  group(id: $groupId) {
    id
    name
    templateConnection(first: 10) {
      templates {
        id
        title
      }
    }
  }
}

Defnyddiwch y newidiynnau hyn:

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

Copïwch yr id ar gyfer y templed yr ydych am ei anfon. Dyma yw eich templateId.

Anfonwch Eich Dogfen Gyntaf

Gludwch y newidyn hwn i mewn i'r Archwiliwr:

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

Ychwanegwch y newidiynnau hyn a disodli'r gwerthoedd lle neuledd:

{
  "input": {
    "groupId": "<your-group-id>",
    "templateId": "<your-template-id>",
    "title": "Test Document",
    "recipients": [
      {
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "jane@example.com",
        "order": 0
      }
    ]
  }
}

Os yw'r mewnbwn yn annilys, mae'r newidyn yn dychwelyd gwall dilysiad ar unwaith.

Os bydd y newidyn yn llwyddo, mae'n dychwelyd ID tasg. Mae Legalesign yn prosesu anfoniadau'n anesmwyth, felly mae'r dasg yn cychwyn y gwaith anfon yn lle aros am gwblhau'r cyflwyno.

Arolwg Adroddiad y Dasg

cyngor

Mae arolwg yn iawn i ddechrau. Ar gyfer cynhyrchu, gallwch newid i tanysgrifiadau i olrhain cynnydd anfon mewn amser real yn lle hynny.

Ar ôl send, defnyddiwch yr ID tasg a ddychwelwyd i arolwg y cwestiwn task:

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

Defnyddiwch y newidiynnau hyn:

{
  "id": "<task-id-from-send>"
}

Mae'r maes report yn eich galluogi i gadarnhau pryd mae creu dogfen wedi cwblhau ar ôl i anfon dilys ddechrau'r dasg asyncron.

Gwylio report.status nes iddo gyrraedd cyflwr terfynol:

• COMPLETED yn golygu bod creu'r ddogfen wedi gorffen
• FAILED yn golygu nad oedd creu'r ddogfen wedi cwblhau'n llwyddiannus

Tra bod y dasg yn dal i redeg, efallai y gwelwch statwsau rhwngol megis PENDING neu READY.

Ar gyfer dechrau a pheilotio, mae arolwg y dasg yn ffordd syml o wirio cynnydd. Ar gyfer cynhyrchu, mae diweddariadau amser real yn cael eu trin yn well gyda tanysgrifiadau.

Gweler:

• cwestiwn tasg
• Adroddiad Tasg
• Datrys Problemau Dilysiad Anfon
• Enghreifftiau Tanysgrifio
• Olrhain Tasgau Anfon gyda Thanysgrifiadau

cyngor

Defnyddiwch gyfeiriad e-bost derbynnydd go iawn yr ydych chi'n ei reoli wrth brawf, fel y gallwch gadarnhau bod yr anfon wedi cwblhau fel disgwyl.

cyngor

Gallwch hefyd echdynnu groupId a templateId o'ch URLs dangosfwrdd a golygydd ffurflenni - nhw yw'r unig rai hir alffa-numerig yn y URLs hynny.

Symud i'r Cod

Ar gyfer mynediad rhaglenedig, dewiswch ffyrdd awdurdodi yn gyntaf a chael tocyn neu allwedd API. Gweler Awdurdodi gyda'r API.

Awdurdodi a Gwneud Cais

Unwaith y bydd gennych eich tocyn neu allwedd API, anfonwch gais GraphQL POST gyda phenawd 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);

Camau Nesaf

1. Os oes angen gosodiad penodol i iaith, defnyddiwch Gosod Node.js neu Gosod C#
2. Os ydych am greu'ch templed eich hun yn gyntaf, dilynwch Llwytho Ffeil fel Templed
3. Darllenwch Anfon Dogfen ar gyfer yr enghraifft cod Node.js lawn
4. Porwch y cyfeirnod newidyn anfon