Inhalte aus Q.wiki-Prozessemodulen per Content API abfragen

Geändert am Do, 2 Apr um 4:12 NACHMITTAGS

Die Q.wiki Content API für Prozessemodule ermöglicht es dir, Inhalte aus Prozessemodulen programmatisch abzufragen. Typische Anwendungsfälle sind die Anbindung von Unternehmenssuchen, Chatbots oder automatisierten Reportings.

Überblick

Die API erlaubt den Zugriff auf Inhalte aus Prozessemodulen unter Berücksichtigung der Berechtigungen des jeweiligen Nutzers. Es werden ausschließlich Seiten ausgegeben, auf die du Zugriff hast.

Die vollständige technische Dokumentation findest du unter https://<tenant>.qwikinow.de/external-api/v1/docs (ersetze <tenant> durch den Namen deiner Q.wiki-Instanz).

Authentifizierungs-Token erstellen

Für den Zugriff auf die API benötigst du ein persönliches Token. Jeder Nutzer kann Tokens mit seinen eigenen Berechtigungen erstellen.

  1. Navigiere zu User > Mein Profil > Content API.

Navigation zu User, Mein Profil, Content API in Q.wiki

  1. Klicke auf Token hinzufügen.

Button Token hinzufügen in der Content-API-Übersicht

  1. Vergib einen Namen für das Token und definiere die Gültigkeitsdauer.
  2. Speichere das Token sicher ab – es wird für alle API-Anfragen benötigt.
Achtung: Das Token wird nur einmalig angezeigt. Wenn du es verlierst, musst du ein neues erstellen.
Tipp: Für die Anbindung einer Unternehmenssuche kann es sinnvoll sein, einen dedizierten Dummy-User in Q.wiki anzulegen, über den du die gewünschten Berechtigungen steuerst. So stellst du sicher, dass keine sensiblen Inhalte versehentlich in der Suche erscheinen.

Bekannte Einschränkungen (Beta)

Thema Einschränkung
Modulfilter Gibt aktuell keine Informationen über Organisationseinheiten (OU) zurück.
Modul-IDs Müssen als kommagetrennte Liste übergeben werden.
Berechtigungen Die berechtigten Nutzer pro Seite sind derzeit nicht über die API abrufbar.
Änderungsvorschläge Änderungsvorschläge haben keinen Einfluss auf das Feld last_changed_at.
Seitenverantwortlicher Wird aktuell nur als ID zurückgegeben. Ein separater Endpunkt ist geplant.

Verwandte Artikel

War dieser Artikel hilfreich?

Das ist großartig!

Vielen Dank für das Feedback

Leider konnten wir nicht helfen

Vielen Dank für das Feedback

Wie können wir diesen Artikel verbessern?

Wählen Sie wenigstens einen der Gründe aus
CAPTCHA-Verifikation ist erforderlich.

Feedback gesendet

Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren