Vai al contenuto principale

Quickstart GraphQL

Questo quickstart ti mostra come usare il GraphQL Explorer per:

  • verificare che il tuo account funzioni con una query semplice
  • trovare il tuo groupId e templateId
  • inviare un documento di prova con i campi minimi richiesti
  • interrogare il report dell’attività per confermare il completamento della creazione del documento
  • spostare lo stesso flusso in Node.js, Python o C#

Prima di Iniziare​

Hai bisogno di:

  • Un account Legalesign a cui puoi accedere
  • Almeno un gruppo e un template nel tuo account
  • Una API key - come ottenere una API key

Scegliere l’Autenticazione​

L’Explorer usa la tua sessione Legalesign autenticata. Nel tuo codice, GraphQL accetta API key e token di accesso OAuth 2.0.

ModalitàHeaderIdeale per
API KeyAuthorization: Bearer <api-key>Automazioni lato server e flussi comuni di invio/lettura. Il modo più rapido per iniziare
OAuth 2.0Authorization: Bearer <access-token>App che costruisci per gli utenti della tua organizzazione, dove ogni persona accede come se stessa. Vedi Integrazione Client OAuth 2.0

Entrambi danno accesso a un sottoinsieme supportato dello schema GraphQL. Controlla le operazioni GraphQL supportate e i badge di autenticazione nelle pagine di riferimento per vedere quali operazioni puoi usare. Gli esempi in questo quickstart funzionano con entrambi.

Aprire il GraphQL Explorer​

Vai al GraphQL Explorer.

informazioni

Se sei autenticato in Legalesign, l’autenticazione è automatica nell’Explorer.

Copia e incolla le query qui sotto nel GraphQL Explorer per iniziare. Più avanti userai la stessa graphql nel tuo codice.

Query Utente​

Inizia con una query innocua per confermare che l’Explorer funziona:

query MyUser {
user {
id
firstName
lastName
email
}
}

Se questa ha successo, la tua sessione Explorer funziona e sei pronto a cercare gli ID necessari per un invio.

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

Ora elenca i gruppi a cui appartiene il tuo utente:

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

Ora effettua la query dei template presenti in quel gruppo:

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

Usa queste variabili:

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

Incolla questa mutation nell’Explorer:

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

Aggiungi queste variabili e sostituisci i valori segnaposto:

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

Dopo send, usa l’ID attività restituito per interrogare la query task:

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

Usa queste variabili:

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);

Una volta che hai il token o la API key, invia una richiesta POST GraphQL con un header Authorization:

Export This Article

Save a copy of this page as PDF or plain text.