Zum Inhalt springen

n8n

Automatisieren Sie Quire mit n8n und dem Quire-Community-Node.

Als Markdown anzeigen

Der Quire-Community-Node für n8n bietet einen Aktions-Node für die REST-API und einen Trigger-Node, der einen Workflow startet, wenn in Quire etwas geschieht. Er hat keine Laufzeitabhängigkeiten und fügt Ihrer n8n-Instanz daher nichts außer sich selbst hinzu.

Installation

Öffnen Sie in n8n Settings, dann Community nodes, wählen Sie Install und geben Sie @quire/n8n-node ein. Bei einem selbst gehosteten n8n können Sie stattdessen im n8n-Benutzerordner npm install @quire/n8n-node ausführen und n8n neu starten.

Verbindung herstellen

The API keys page with a key named for an n8n automation.
Create a key at /admin/integrations/api-keys and paste it into the Quire credential in n8n.

Erstellen Sie einen Zugang. Es werden zwei Arten angeboten:

  • Quire API Key: Base URL ist die Adresse Ihrer Organisation ohne abschließenden Schrägstrich, zum Beispiel https://acme.quirelms.com. API Key ist ein Schlüssel, den ein Administrator unter /admin/integrations/api-keys erstellt hat und der mit qk_live_ beginnt. Geben Sie ihm nur die Berechtigungsbereiche, die der Workflow benötigt.
  • Quire OAuth2: für Workflows, die als eine bestimmte Person handeln sollen. Registrieren Sie unter /admin/integrations/oauth-clients einen OAuth-Client mit der Weiterleitungsadresse von n8n (n8n zeigt sie im Zugang an) und geben Sie anschließend Client-ID, Secret und Berechtigungsbereiche ein.

Aktionen

Der Quire-Node deckt Benutzer, Kurse, Einschreibungen, Gruppen, Abschlüsse, Bewertungen, Zertifikate, Einreichungen, Quizversuche, Programme, Bestellungen, E-Mail und Organisationen ab. Für jede Ressource werden – sofern die API sie unterstützt – Auflisten, Abrufen, Erstellen, Aktualisieren und Löschen angeboten, ebenso das Upsert über eine externe ID. Das eignet sich für Synchronisierungen: Wird derselbe Workflow zweimal ausgeführt, entstehen keine Duplikate.

Die Operationen werden aus dem OpenAPI-Dokument von Quire erzeugt und stimmen daher Feld für Feld mit der API-Referenz überein. Jede Operation kann auch als Werkzeug eines n8n-KI-Agenten verwendet werden; ihre Beschreibung stammt aus der API-Referenz.

Listen geben standardmäßig alle Seiten zurück. Deaktivieren Sie für große Organisationen Return All und legen Sie ein Limit fest.

Trigger

Fügen Sie den Quire Trigger-Node hinzu, wählen Sie den Zugang und dann die Events aus: ein Ereignis nach Namen wie enrolment.created, einen ganzen Bereich wie course.* oder alle Ereignisse. Wenn Sie den Workflow aktivieren, erstellt der Node in Quire ein Webhook-Abonnement für die n8n-Adresse; beim Deaktivieren wird das Abonnement entfernt.

Die Signatur jeder Zustellung wird geprüft, bevor der Workflow ausgeführt wird. Eine nicht verifizierte Zustellung wird mit einem Node-Fehler verworfen, sodass eine gefälschte Anfrage den Workflow nicht starten kann. data im Ereignis enthält Kennungen; fügen Sie nach dem Trigger einen Quire-Node hinzu, um den vollständigen Datensatz abzurufen.

Beispiel: Willkommens-E-Mail bei einer Einschreibung

  1. Quire Trigger für enrolment.created.
  2. Quire-Node, Ressource Users, Operation Get, mit der Benutzer-ID {{$json.data.user_id}}.
  3. Quire-Node, Ressource Courses, Operation Get, mit {{$json.data.course_id}}.
  4. Ihr E-Mail- oder Chat-Node mit dem Namen der Person und dem Kurstitel.

Fehlerbehebung

  • 401 bei jedem Aufruf: Basis-URL und Schlüssel gehören zu verschiedenen Organisationen oder der Schlüssel wurde widerrufen.
  • 403 bei einer Operation: Dem Schlüssel fehlt dieser Berechtigungsbereich. Fügen Sie ihn unter /admin/integrations/api-keys hinzu.
  • Der Trigger wird nie ausgelöst: Die Webhook-Adresse von n8n muss von Quire aus über HTTPS erreichbar sein. Prüfen Sie das Zustellungsprotokoll des Abonnements unter /admin/webhooks.
Navigation

Suchbegriff eingeben…

↑↓ navigieren↵ auswählenEsc schließen