Dechrau Cyflym gyda GraphQL

Mae’r dechrau cyflym hwn yn dangos sut i ddefnyddio’r Explorer GraphQL i:

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

Cyn i Chi Ddechrau

Mae angen i chi gael:

• Mynediad API wedi’i alluogi ar gyfer eich cyfrif. Os nad oes gennych eto, cysylltwch â ni.
• Cyfrif Legalesign y gallwch fewngofnodi iddo
• O leiaf un grŵp a un templed yn eich cyfrif

Dewiswch Ogyrru

Mae’r Explorer yn defnyddio eich sesiwn Legalesign wedi’ch mewngofnodi. Yn eich cod eich hun, mae GraphQL yn cefnogi awdurdodi SRP ar gyfer mynediad i’r schema llawn a allweddi API ar gyfer is-setiyn cefnog.

Modd	Gorchudd	Penawd	Gorau ar gyfer
SRP	Schema GraphQL llawn	Authorization: Bearer <access-token>	Integreiddiadau cyflawn
Allwedd API	Is-set cefnog yn unig	Authorization: Bearer <api-key>	Awtomatwaith ochr gweinydd a llifiau anfon/darllen cyffredin

Mae’r dechrau cyflym hwn yn defnyddio awdurdodi SRP yn y enghreifftiau iaith oherwydd ei fod yn gweithio ar draws y schema GraphQL llawn. Os ydych yn defnyddio allwedd API Portal Datblygwr, gwiriwch y Cyfeirlyfr Allwedd API GraphQL a’r bathodynnau awdurdodi ar dudalennau cyfeirlyfr.

Agor yr Explorer GraphQL

Ewch i’r Explorer GraphQL.

gwybodaeth

Os ydych wedi mewngofnodi i Legalesign, mae awdurdodi yn awtomatig yn yr Explorer.

Copïwch a gludwch y ymholiadau isod i mewn i’r Explorer GraphQL i ddechrau. Yn nes ymlaen, byddwch yn defnyddio’r un graphql yn eich cod eich hun.

Ymholi Eich Defnyddiwr

Dechreuwch gyda chwestiwn di-berygl i gadarnhau bod yr Explorer yn gweithio:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Os bydd hyn yn llwyddo, mae eich sesiwn Explorer yn gweithio ac rydych chi’n barod i chwilio am yr IDau sydd eu hangen ar gyfer anfon.

Ymholi Eich Grwpiau

Yna, 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 rydych am anfon oddi wrtho. Dyma eich groupId.

Ymholi Templedi yn y Grŵp Hynny

Nawr, ymholiwch am y templedi yn y grŵp hwnnw:

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

Defnyddiwch y newidiadau hyn:

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

Copïwch yr id ar gyfer y templed rydych am ei anfon. Dyma’ch templateId.

Anfon Eich Dogfen Gyntaf

Gludwch y newidyn hwn i’r Explorer:

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

Ychwanegwch y newidiadau hyn a disodli’r gwerthoedd lle mae’r lleoliadau:

{
  "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, bydd y newidyn yn dychwelyd gwall dilysu ar unwaith.

Os yw’r newidyn yn llwyddo, mae’n dychwelyd ID tasg. Mae Legalesign yn prosesu anfoniadau’n asynhronig, felly mae’r dasg yn cychwyn y swydd anfon yn hytrach na disgwyl i’r danfon orffen.

Arolygu Adroddiad y Tasg

cyngor

Mae arolygu’n iawn i ddechrau. Ar gyfer cynhyrchiad, gallwch newid i tanysgrifiadau i olrhain cynnydd anfon mewn amser real yn hytrach.

Ar ôl send, defnyddiwch yr ID tasg a ddychwelwyd i arolygu’r ymholiad task:

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

Defnyddiwch y newidiadau hyn:

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

Mae’r maes report yn caniatáu i chi gadarnhau pryd mae creu dogfen wedi’i gwblhau ar ôl i anfon dilys gychwyn y dasg asynhronig.

Monitro report.status nes yw’n cyrraedd cyfnod terfynol:

• COMPLETED yn golygu bod creu dogfen wedi gorffen
• FAILED yn golygu nad oedd creu dogfen wedi’i gwblhau’n llwyddiannus

Tra bod y dasg yn dal i redeg, efallai y gwelwch statysau canolraddol fel PENDING neu READY.

Ar gyfer dechrau a phrototeipio, mae arolygu task yn ffordd syml o wirio cynnydd. Ar gyfer cynhyrchiad, mae diweddariadau amser real yn cael eu trin yn well gyda tanysgrifiadau.

Gweler:

• ymholiad tasg
• TaskReport
• Datrys Problemau Dilysu Anfon
• Enghreifftiau Tanysgrifio
• Olrhain Tasgau Anfon gyda Thanysgrifiadau

cyngor

Defnyddiwch gyfeiriad e-bost derbynnydd go iawn yr ydych yn ei reoli wrth brofi, fel y gallwch gadarnhau bod yr anfon wedi’i gwblhau fel y disgwylir.

cyngor

Gallwch hefyd dynnu groupId a templateId o’ch sgrin lywio a URLs golygydd fformiau – nhw yw’r unig rifau alffaniwmerig hir yn y URLs hynny.

Symud i God

Ar gyfer mynediad rhaglenedig, dewiswch yn gyntaf fodd awdurdodi 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 POST GraphQL 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 arnoch, defnyddiwch Gosodiad Node.js neu Gosodiad C#
2. Os hoffech greu eich templed eich hun yn gyntaf, dilynwch Llwytho Ffeil fel Templed
3. Darllenwch Anfon Dogfen am yr enghraifft cod Node.js llawn
4. Poriwch y cyfeirlyfr newidyn anfon