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
groupIdundtemplateIdzu finden - ein Testdokument mit den minimal erforderlichen Feldern zu senden
- den Aufgabenbericht abzufragen, um zu bestätigen, dass die Dokumenterstellung abgeschlossen ist
- denselben Ablauf in Node.js, Python oder C# zu übertragen
Bevor Sie Beginnen
Sie benötigen:
- Ein Legalesign-Konto, bei dem Sie sich anmelden können
- Mindestens eine Gruppe und eine Vorlage in Ihrem Konto
- Einen API-Schlüssel – wie Sie einen API-Schlüssel erhalten
Authentifizierung Wählen
Der Explorer verwendet Ihre angemeldete Legalesign-Sitzung. In Ihrem eigenen Code akzeptiert GraphQL API-Schlüssel und OAuth 2.0 Zugriffstoken.
| Modus | Header | Am besten für |
|---|---|---|
| API-Schlüssel | Authorization: Bearer <api-key> | Serverseitige Automatisierung und gängige Sende-/Leseabläufe. Der schnellste Weg, um zu starten |
| OAuth 2.0 | Authorization: Bearer <access-token> | Apps, die Sie für die Benutzer Ihrer Organisation erstellen, bei denen sich jede Person selbst anmeldet. Siehe OAuth 2.0 Client Integration |
Beide gewähren Zugriff auf einen unterstützten Teil des GraphQL-Schemas. Prüfen Sie die unterstützten GraphQL-Operationen und die Auth-Badges auf den Referenzseiten, um zu sehen, welche Operationen Sie verwenden können. Die Sprachbeispiele in diesem Schnellstart funktionieren mit beiden.
Öffnen Sie den GraphQL Explorer
Gehen Sie zum GraphQL Explorer.
Wenn Sie bei Legalesign angemeldet sind, erfolgt die Authentifizierung im Explorer automatisch.
Kopieren Sie die untenstehenden Abfragen und fügen Sie sie in den GraphQL Explorer ein, um zu starten. Später verwenden Sie denselben graphql-Code in Ihrem eigenen Code.
Abfrage Ihres Benutzers
Beginnen Sie mit einer ungefährlichen 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 das Senden benötigten IDs nachzuschlagen.
Abfrage Ihrer Gruppen
Listen Sie als nächstes die Gruppen auf, zu denen Ihr Benutzer gehört:
query MyGroups {
user {
memberConnection(first: 10) {
groupMembers {
group {
id
name
}
}
}
}
}
Kopieren Sie die id der Gruppe, von der Sie senden möchten. Dies ist Ihre groupId.
Abfrage der Vorlagen in dieser Gruppe
Abfragen Sie nun die Vorlagen in dieser Gruppe:
query GroupTemplates($groupId: ID!) {
group(id: $groupId) {
id
name
templateConnection(first: 10) {
templates {
id
title
}
}
}
}
Verwenden Sie diese Variablen:
{
"groupId": "<your-group-id>"
}
Kopieren Sie die id der Vorlage, die Sie senden möchten. Dies ist Ihre templateId.
Senden Ihres Ersten Dokuments
Fügen Sie diese Mutation in den Explorer ein:
mutation SendDocument($input: DocumentSendSettingsInput!) {
send(input: $input)
}
Fügen Sie diese Variablen hinzu und ersetzen Sie die Platzhalterwerte:
{
"input": {
"groupId": "<your-group-id>",
"templateId": "<your-template-id>",
"title": "Test Document",
"recipients": [
{
"firstName": "Jane",
"lastName": "Smith",
"email": "jane@example.com",
"order": 0
}
]
}
}
Wenn die Eingabe ungültig ist, gibt die Mutation sofort einen Validierungsfehler zurück.
Wenn die Mutation erfolgreich ist, gibt sie eine Aufgaben-ID zurück. Legalesign verarbeitet Sendungen asynchron, daher startet die Aufgabe den Sendevorgang statt auf den Abschluss der Zustellung zu warten.
Abfrage des Aufgabenberichts
Polling ist zum Einstieg in Ordnung. Für die Produktion können Sie stattdessen auf Subscriptions wechseln, um den Versandfortschritt in Echtzeit zu verfolgen.
Nach send verwenden Sie die zurückgegebene Aufgaben-ID, um die task-Abfrage abzufragen:
query GetTask($id: ID!) {
task(id: $id) {
data
report {
status
batchId
documents
errors
}
}
}
Verwenden Sie diese Variablen:
{
"id": "<task-id-from-send>"
}
Das report-Feld ermöglicht es Ihnen zu bestätigen, wann die Dokumenterstellung nach einem gültigen Sendebefehl, der die asynchrone Aufgabe gestartet hat, abgeschlossen ist.
Überwachen Sie report.status, bis es einen Endzustand erreicht:
COMPLETEDbedeutet, dass die Dokumenterstellung abgeschlossen istFAILEDbedeutet, dass die Dokumenterstellung nicht erfolgreich abgeschlossen wurde
Während die Aufgabe noch läuft, können Sie Zwischenzustände wie PENDING oder READY sehen.
Zum Einstieg und Prototyping ist das Polling der task eine einfache Möglichkeit, den Fortschritt zu prüfen. Für die Produktion sind Echtzeit-Updates besser mit Subscriptions zu handhaben.
Siehe:
- task-Abfrage
- TaskReport
- Sendvalidierung Fehler beheben
- Subscription Beispiele
- Sendaufgaben mit Subscriptions verfolgen
Verwenden Sie beim Testen eine echte Empfänger-E-Mail-Adresse, die Sie kontrollieren, damit Sie bestätigen können, dass das Senden wie erwartet abgeschlossen wurde.
Sie können groupId und templateId auch aus Ihren Dashboard- und Form-Editor-URLs extrahieren – sie sind die einzigen langen alphanumerischen Werte in diesen URLs.
Zum Code Wechseln
Für den programmatischen Zugriff wählen Sie zuerst einen Authentifizierungsmodus und erhalten ein Token oder einen API-Schlüssel. Siehe Authentifizieren mit der API.
Authentifizieren und Anfragen Stellen
Sobald Sie Ihr Token oder Ihren API-Schlüssel haben, senden Sie eine GraphQL-POST-Anfrage mit einem Authorization-Header:
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);
Nächste Schritte
- Wenn Sie eine sprachspezifische Einrichtung benötigen, verwenden Sie Node.js Einrichtung oder C# Einrichtung
- Wenn Sie zuerst Ihre eigene Vorlage erstellen möchten, folgen Sie Eine Datei als Vorlage hochladen
- Lesen Sie Ein Dokument senden für das vollständige Node.js-Codebeispiel
- Stöbern Sie in der send-Mutation Referenz