GraphQL Schnellstart

Dieser Schnellstart zeigt Ihnen, wie Sie den GraphQL Explorer verwenden, um:

• zu bestätigen, dass Ihr Konto mit einer einfachen Abfrage funktioniert
• Ihre groupId und templateId zu finden
• ein Testdokument mit den minimal erforderlichen Feldern zu senden
• den Aufgabenbericht abzufragen, um die abgeschlossene Dokumenterstellung zu bestätigen
• denselben Ablauf in Node.js, Python oder C# zu übertragen

Bevor Sie Beginnen

Sie benötigen:

• Ein Legalesign-Konto, in das Sie sich einloggen können
• Mindestens eine Gruppe und eine Vorlage in Ihrem Konto
• Einen API-Schlüssel - So erhalten Sie einen API-Schlüssel

Authentifizierung Wählen

Der Explorer verwendet Ihre eingeloggte Legalesign-Sitzung. In Ihrem eigenen Code unterstützt GraphQL SRP-Authentifizierung für den vollständigen Schema-Zugriff und API-Schlüssel für einen unterstützten Teilbereich.

Modus	Abdeckung	Header	Am besten für
SRP	Vollständiges GraphQL-Schema	Authorization: Bearer <access-token>	Komplette Integrationen
API-Schlüssel	Nur unterstützter Teilbereich	Authorization: Bearer <api-key>	Serverseitige Automatisierung und häufige Sende-/Leseabläufe

Dieser Schnellstart verwendet in den Sprachbeispielen SRP-Authentifizierung, da sie über das gesamte GraphQL-Schema hinweg funktioniert. Wenn Sie einen Developer Portal API-Schlüssel verwenden, prüfen Sie die API-Schlüssel-GraphQL-Referenz und die Auth-Symbole auf den Referenzseiten.

Öffnen Sie den GraphQL Explorer

Gehen Sie zum GraphQL Explorer.

Info

Wenn Sie bei Legalesign eingeloggt sind, erfolgt die Authentifizierung im Explorer automatisch.

Kopieren und fügen Sie die untenstehenden Abfragen in den GraphQL Explorer ein, um zu beginnen. Später verwenden Sie dieselbe GraphQL-Abfrage in Ihrem eigenen Code.

Abfragen Ihres Benutzers

Beginnen Sie mit einer harmlosen Abfrage, um zu bestätigen, dass der Explorer funktioniert:

query MyUser {
  user {
    id
    firstName
    lastName
    email
  }
}

Wenn dies gelingt, funktioniert Ihre Explorer-Sitzung und Sie sind bereit, die für einen Versand benötigten IDs nachzuschlagen.

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

Listen Sie als Nächstes die Gruppen auf, denen Ihr Benutzer angehört:

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

Fragen Sie nun die Vorlagen in dieser Gruppe ab:

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

Verwenden Sie diese Variablen:

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

Fügen Sie diese Mutation in den Explorer ein:

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

Fügen Sie diese Variablen hinzu und ersetzen Sie die Platzhalterwerte:

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

Nach send verwenden Sie die zurückgegebene Aufgaben-ID, um die task-Abfrage abzufragen:

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

Verwenden Sie diese Variablen:

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

Sobald Sie Ihr Token oder Ihren API-Schlüssel haben, senden Sie eine GraphQL-POST-Anfrage mit einem Authorization-Header: