Γρήγορη εκκίνηση GraphQL

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

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

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

Χρειάζεστε:

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

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

Ο Explorer χρησιμοποιεί τη σύνδεση σας στο Legalesign. Στον δικό σας κώδικα, το GraphQL υποστηρίζει πιστοποίηση SRP για πλήρη πρόσβαση σε όλο το σχήμα και κλειδιά API για υποσύνολο που υποστηρίζεται.

Τρόπος	Κάλυψη	Header	Καλύτερο για
SRP	Πλήρες σχήμα GraphQL	Authorization: Bearer <access-token>	Πλήρεις ενσωματώσεις
Κλειδί API	Μόνο υποσύνολο που υποστηρίζεται	Authorization: Bearer <api-key>	Αυτοματοποίηση από διακομιστή και συνήθεις ροές αποστολής/ανάγνωσης

Αυτή η γρήγορη εκκίνηση χρησιμοποιεί την πιστοποίηση SRP στα παραδείγματα γλωσσών επειδή λειτουργεί σε όλο το σχήμα GraphQL. Εάν χρησιμοποιείτε κλειδί API από το Developer Portal, ελέγξτε το API-key GraphQL reference και τα σήματα πιστοποίησης στις σελίδες αναφοράς.

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

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

Πληροφορίες

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

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

Κάντε Ερώτημα για τον Χρήστη σας

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

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Εάν αυτό πετύχει, η συνεδρία του Explorer λειτουργεί και είστε έτοιμοι να αναζητήσετε τα απαραίτητα αναγνωριστικά για αποστολή.

Κάντε Ερώτημα για τις Ομάδες σας

Έπειτα, προβάλετε τις ομάδες στις οποίες ανήκει ο χρήστης σας:

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

Αντιγράψτε το id της ομάδας από την οποία θέλετε να στείλετε. Αυτό είναι το groupId σας.

Κάντε Ερώτημα για τα Πρότυπα σε Εκείνη την Ομάδα

Τώρα κάντε ερώτημα για τα πρότυπα σε εκείνη την ομάδα:

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

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

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

Αντιγράψτε το id του προτύπου που θέλετε να στείλετε. Αυτό είναι το templateId σας.

Στείλτε το Πρώτο Σας Έγγραφο

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

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

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

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

Εάν το input δεν είναι έγκυρο, η μετάλλαξη επιστρέφει άμεσα σφάλμα επικύρωσης.

Αν η μετάλλαξη πετύχει, επιστρέφει ένα ID εργασίας. Το Legalesign επεξεργάζεται τις αποστολές ασύγχρονα, έτσι η εργασία ξεκινά την αποστολή αντί να περιμένει να ολοκληρωθεί η παράδοση.

Ελέγξτε την Αναφορά Εργασίας

Συμβουλή

Ο έλεγχος είναι επαρκής για να ξεκινήσετε. Για παραγωγή, μπορείτε να μεταβείτε σε subscriptions για να παρακολουθείτε την πρόοδο αποστολής σε πραγματικό χρόνο.

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

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

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

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

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

Παρακολουθείτε το report.status μέχρι να φτάσει σε τελικό στάδιο:

• COMPLETED σημαίνει ότι η δημιουργία εγγράφου ολοκληρώθηκε
• FAILED σημαίνει ότι η δημιουργία εγγράφου δεν ολοκληρώθηκε επιτυχώς

Ενώ η εργασία είναι σε εξέλιξη, μπορεί να δείτε ενδιάμεσες καταστάσεις όπως PENDING ή READY.

Για να ξεκινήσετε και για πρωτότυπο, το polling του task είναι ένας απλός τρόπος να ελέγχετε την πρόοδο. Για παραγωγή, οι ενημερώσεις σε πραγματικό χρόνο διαχειρίζονται καλύτερα με subscriptions.

Δείτε:

• task query
• TaskReport
• Επίλυση προβλημάτων επικύρωσης αποστολής
• Παραδείγματα συνδρομών
• Παρακολούθηση εργασιών αποστολής με συνδρομές

Συμβουλή

Χρησιμοποιήστε μια πραγματική διεύθυνση email παραλήπτη που έχετε υπό τον έλεγχό σας κατά τη διάρκεια των δοκιμών, ώστε να μπορείτε να επιβεβαιώσετε ότι η αποστολή ολοκληρώθηκε όπως αναμενόταν.

Συμβουλή

Μπορείτε επίσης να εξάγετε το groupId και το templateId από τα URLs του πίνακα ελέγχου και του επεξεργαστή φορμών – είναι τα μοναδικά μακριά αλφαριθμητικά σε αυτά τα URLs.

Μεταβείτε σε Κώδικα

Για προγραμματιστική πρόσβαση, επιλέξτε πρώτα τρόπο πιστοποίησης και αποκτήστε ένα token ή κλειδί API. Δείτε Authenticate with the API.

Πιστοποιηθείτε και Κάντε Αίτηση

Μόλις έχετε το token ή το κλειδί API, στείλτε ένα GraphQL POST αίτημα με header 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);

Επόμενα Βήματα

1. Εάν χρειάζεστε εγκατάσταση ανά γλώσσα, χρησιμοποιήστε Node.js Setup ή C# Setup
2. Εάν θέλετε να δημιουργήσετε το δικό σας πρότυπο πρώτα, ακολουθήστε Upload a File as a Template
3. Διαβάστε το Send a Document για το πλήρες παράδειγμα κώδικα Node.js
4. Περιηγηθείτε στην αναφορά μετάλλαξης send