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

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

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

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

Χρειάζεστε:

• ενεργοποιημένη πρόσβαση API για τον λογαριασμό σας. Αν δεν την έχετε ακόμα, επικοινωνήστε μαζί μας.
• έναν λογαριασμό Legalesign που μπορείτε να συνδεθείτε
• Τουλάχιστον μία ομάδα και ένα πρότυπο στον λογαριασμό σας

Επιλέξτε Ταυτοποίηση

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

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

Αυτή η γρήγορη εκκίνηση χρησιμοποιεί την ταυτοποίηση 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 λειτουργεί και είστε έτοιμοι να βρείτε τα ID που χρειάζονται για την αποστολή.

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

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

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
      }
    ]
  }
}

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

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

Κάντε Polling στην Αναφορά Εργασίας

συμβουλή

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

Μετά το send, χρησιμοποιήστε το επιστραφέν 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
• Troubleshoot Send Validation
• Subscription Examples
• Track Send Tasks with Subscriptions

συμβουλή

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

συμβουλή

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

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

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

Πραγματοποιήστε Ταυτοποίηση και Στείλτε Αίτημα

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