API- und Integrationsgrundlagen | Gluu Documentation 📘

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.

API-Token beziehen #

Gehen Sie zu Kontoeinstellungen > Apps Integration > API-Integration.
Klicken Sie auf Einstellungen, um das Autorisierungs-Token zu generieren. (Kontoinhaber/Administrator erforderlich.)
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.

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/Antworten sind JSON. Zeitstempel sind UTC, 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 Nutzlasten, indem Sie nach bestimmten Klassen filtern, die Sie benötigen.

Klassentypen #

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

Kategorie
group
Prozess
Aktivität
Formular
Formularversion
Formulardaten
Aufgabe
Fallworkflow
user
Vorschlag

Hierarchie der Klassentypen #

Understand Sie die Parent-Child-Beziehungen, um Abfragen und Joins zu planen.

Caseworkflow-API – Übersicht #

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

Starten eines Fallworkflows #

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

Webhaken #

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).
Suchen Sie nach dem Empfang eines Ereignisses nach Details, z. B. Task Lookup API.

Aufgabe abschließen #

Sie können eine Aufgabe programmgesteuert auf die gleiche Weise erledigen wie beim Einreichen in Gluu. Das Einreichen von Formulardaten über die API wird nicht unterstützt – Formulare sollten von Benutzern ausgefüllt werden.