Μετάβαση στο κύριο περιεχόμενο

Γρήγορη Έναρξη GraphQL

Αυτή η γρήγορη έναρξη σας δείχνει πώς να χρησιμοποιήσετε τον GraphQL Explorer για να:

  • επιβεβαιώσετε ότι ο λογαριασμός σας λειτουργεί με ένα απλό ερώτημα
  • βρείτε το groupId και το templateId
  • στείλετε ένα δοκιμαστικό έγγραφο με τα ελάχιστα απαιτούμενα πεδία
  • ελέγχετε περιοδικά την αναφορά εργασίας για να επιβεβαιώσετε την ολοκλήρωση της δημιουργίας εγγράφου
  • μεταφέρετε την ίδια ροή σε Node.js, Python ή C#

Πριν Ξεκινήσετε​

Χρειάζεστε:

  • Έναν λογαριασμό Legalesign στον οποίο μπορείτε να συνδεθείτε
  • Τουλάχιστον μία ομάδα και ένα πρότυπο στον λογαριασμό σας
  • Ένα κλειδί API - πώς να λάβετε ένα κλειδί API

Επιλέξτε Τρόπο Πιστοποίησης​

Ο Explorer χρησιμοποιεί την συνεδρία Legalesign στην οποία έχετε συνδεθεί. Στον δικό σας κώδικα, το GraphQL δέχεται κλειδιά API και access tokens OAuth 2.0.

ΤρόποςHeaderΚαλύτερο για
Κλειδί APIAuthorization: Bearer <api-key>Αυτοματισμούς στην πλευρά του διακομιστή και κοινές ροές αποστολής/ανάγνωσης. Ο γρηγορότερος τρόπος να ξεκινήσετε
OAuth 2.0Authorization: Bearer <access-token>Εφαρμογές που δημιουργείτε για τους χρήστες της οργάνωσής σας, όπου κάθε άτομο συνδέεται ως αυτός. Δείτε Ολοκλήρωση Πελάτη OAuth 2.0

Και οι δύο παρέχουν πρόσβαση σε υποσύνολο του υποστηριζόμενου GraphQL σχήματος. Ελέγξτε τις υποστηριζόμενες λειτουργίες GraphQL και τα σήματα πιστοποίησης στις σελίδες αναφοράς για να δείτε ποιες λειτουργίες μπορείτε να χρησιμοποιήσετε. Τα παραδείγματα γλώσσας σε αυτή τη γρήγορη έναρξη λειτουργούν με κάθε επιλογή.

Ανοίξτε τον GraphQL Explorer​

Μεταβείτε στον GraphQL Explorer.

Πληροφορίες

Αν είστε συνδεδεμένοι στο Legalesign, η πιστοποίηση γίνεται αυτόματα στον Explorer.

Αντιγράψτε και επικολλήστε τα ερωτήματα παρακάτω στον GraphQL Explorer για να ξεκινήσετε. Αργότερα, θα χρησιμοποιήσετε το ίδιο graphql στον δικό σας κώδικα.

Ερώτημα για τον Χρήστη σας​

Ξεκινήστε με ένα ακίνδυνο ερώτημα για να επιβεβαιώσετε ότι ο Explorer λειτουργεί:

query MyUser {
user {
id
firstName
lastName
email
}
}

Αν αποδώσει, η συνεδρία σας στον Explorer λειτουργεί και είστε έτοιμοι να αναζητήσετε τα απαραίτητα IDs για αποστολή.

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

Στη συνέχεια, καταγράψτε τις ομάδες στις οποίες ανήκει ο χρήστης σας:

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

Κάντε ερώτημα για τα πρότυπα σε αυτήν την ομάδα:

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

Χρησιμοποιήστε αυτές τις μεταβλητές:

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

Επικολλήστε αυτή τη μετάλλαξη στον Explorer:

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

Προσθέστε αυτές τις μεταβλητές και αντικαταστήστε τις τιμές-δείκτες:

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

Μετά το send, χρησιμοποιήστε το επιστρεφόμενο task ID για να κάνετε ερώτημα task:

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

Χρησιμοποιήστε αυτές τις μεταβλητές:

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

Μόλις έχετε το token ή το κλειδί API, στείλτε ένα GraphQL POST αίτημα με header Authorization: