Inhalte aus Q.wiki-Prozessemodulen per API abfragen

Geändert am Fr, 21 Nov um 10:51 VORMITTAGS

Sie benötigen Key User Rechte um die folgenden Schritte durchzuführen.

Die Q.wiki API (aktuell noch Beta) für Prozessemodule ermöglicht das Abfragen von Inhalten aus den Prozessenmodulen. Typische Anwendungsfälle sind die Anbindung von Unternehmenssuchen, Chatbots oder automatisierte Reportings.

Die API wird als kostenpflichtige Zusatzoption zur Verfügung stehen. Form

Nutzung der API

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

Authentifizierungs-Token erstellen

Navigiere zu User → Profile → Integrationen.

Wähle Token erstellen.

Vergib einen Namen für das Token und definiere die Gültigkeitsdauer.

Speichere das Token sicher – es wird für alle API-Anfragen benötigt.

Hinweis:
Jeder Nutzer kann Tokens mit seinen eigenen Berechtigungen erstellen.
Die vollständige API-Dokumentation findest du im Menü User → Profile → Integrationen unter dem entsprechenden Link.

Form

Wichtige Hinweise zur Nutzung

Für die Anbindung einer Unternehmenssuche kann es sinnvoll sein, einen dedizierten Dummy-User in Q.wiki zu hinterlegen, über den die gewünschten Berechtigungen gesteuert werden. So stellst du sicher, dass keine sensiblen Inhalte versehentlich in der Suche erscheinen.

Die API befindet sich im Beta-Status: Änderungen an Endpunkten und Verhalten sind während dieser Zeit möglich.

Form

Einschränkungen (Details in der technischen Doku)

Die technische Doku wird unter https://tenant.qwikinow.de/external-api/v1/docs erreichbar sein.

Token-Erstellung: Jeder Nutzer kann Tokens mit seinen Berechtigungen erstellen.

Modulfilter: Gibt aktuell keine Informationen über Organisationseinheiten (OU).

(Module IDs: Müssen als kommagetrennte Liste übergeben werden.)

Berechtigungen: Die Berechtigten User pro Seite sind derzeit nicht über die API verfügbar (z. B. OAuth).

Änderungsvorschläge: Änderungen haben keinen Einfluss auf das Feld last changed at.

Responsible: Wird aktuell nur als ID übergeben; separater Endpunkt geplant.

Inhalte von Dateiseiten können derzeit nicht abgefragt werden (separater Endpunkt geplant)