API- und Integrationsgrundlagen

Ziel: Verbinden Sie Gluu über unsere REST-API mit Analysen, RPA und anderen Systemen, mit klaren Anleitungen zu Token, Schema, Klassentypen und Caseworkflow-Endpunkten.

Sie können die API für Power BI, Datenanalysen oder Integrationen mit RPA-Tools verwenden.

Bevor Sie starten #

• Add-on-Anforderung: Die REST-API und Webhooks erfordern das Add-on „APIs und Schnittstellen“. Es ist nicht standardmäßig in den Plänen Core, Essential oder Advanced enthalten.
• Rolle: Sie benötigen Zugriff als Kontoinhaber/Administrator (Konto verwalten), um ein API-Token zu generieren oder Webhooks zu konfigurieren.
• Einrichtung: Keine spezielle Einrichtung erforderlich. Generieren Sie einfach ein Token in den Kontoeinstellungen, sobald das Add-on aktiviert ist.

API-Token beziehen #

1. Gehen Sie zu Kontoeinstellungen > Apps und Integration > API-Integration.
2. Klicken Sie auf Einstellungen, um das Autorisierungs-Token zu generieren. (Kontoinhaber/Administrator erforderlich.)
3. Bewahren Sie das Token sicher auf.

Verwenden Sie schreibgeschützte Token für Lesevorgänge. Für Schreibvorgänge erstellen Sie ein imitiertes Token, damit Änderungen als dieser Benutzer protokolliert werden.

Sie sind fertig, sobald Sie ein Token sicher gespeichert haben, das für Ihre Anfragen bereitsteht.

OpenAPI-Spezifikation #

Hier können Sie die API durchsuchen: api.gluu.biz/api-browser

Schema-Grundlagen #

Der gesamte Zugriff erfolgt über HTTPS von https://api.gluu.biz. Anfragen und Antworten sind im JSON-Format. Zeitstempel sind in UTC und folgen ISO 8601:

YYYY-MM-DDTHH:MM:SSZ

Entitäten enthalten eine Klasse und eine ID:

{
  "_class": "component",
  "_id": "custcomp-3067881d-72fd-41f4-8123-2ef1ec827f9c",
  "prop1": "..."
}

Reduzieren Sie die Nutzlast, indem Sie nur nach den Klassen filtern, die Sie benötigen.

Klassentypen #

/data Abfragen geben Arrays zurück, in denen jedes Objekt ein _type hat, z. B.:

• category
• group
• process
• activity
• form
• formversion
• formdata
• task
• caseworkflow
• user
• suggestion

Hierarchie der Klassentypen #

Machen Sie sich mit den Eltern-Kind-Beziehungen vertraut, um Abfragen und Joins zu planen.

Caseworkflow-API: Übersicht #

Caseworkflows werden von Menschen gesteuert. Sie können sie über die API starten und verfolgen und mit Webhooks auf Ereignisse reagieren.

Caseworkflow starten #

Verwenden Sie diesen Endpunkt, um einen Caseworkflow aus einer Vorlage zu starten: API: Caseworkflow starten.

Webhooks #

• Auslöser: Abgeschlossene Caseworkflow-Aufgabe, Abgeschlossene geplante Aufgabe.
• Konfigurieren Sie unter Konto verwalten > Apps und Integrationen > Webhooks.
• Ereignisse werden einmalig zugestellt. EventId ist eindeutig. Die Nutzlast enthält IDs (keine erweiterten Daten).
• Rufen Sie nach dem Empfang eines Ereignisses die Details ab, z. B. über die Task-Lookup-API.

Aufgabe abschließen #

Sie können eine Aufgabe programmgesteuert auf dieselbe Weise abschließen, wie Sie sie in Gluu einreichen. Das Einreichen von Formulardaten über die API wird nicht unterstützt. Formulare sollten von Benutzern ausgefüllt werden.

FAQ: API- und Integrationsgrundlagen #