PORTAL und PPS Knowledge Base
API Dokumentation PORTAL
Die interaktive Entwicklerdokumentation der PEIQ Cloud-Connect API kann über die Administration & Moderation oder unter /admin/apidoc aufgerufen werden. Voraussetzung hierfür ist die Berechtigung “Zugang zur API-Dokumentation”.
Funktionalitäten der API Dokumentation
Aufbau nach Open-API-Spezifikation
Downloadmöglichkeit pro Modul oder der kompletten API Dokumentation im JSON-Format
Einfache Nutzung dank “TRY”-Funktion
Inhaltsverzeichnis
Interaktive API Dokumentation nach Open API Spezifikation
Die im PORTAL erreichbare interaktive API Dokumentation ist nach der OpenAPI-Spezifikation erstellt. Die Dokumentation ist interaktiv gestaltet und bietet eine Übersicht der potenziellen Anwendungsmöglichkeiten der diversen APIs im PEIQ PORTAL. Voraussetzung für den Zugang zur interaktiven Dokumentation ist die Berechtigung “Zugang zur API-Dokumentation”.
Modulübersicht
Die Modulübersicht zeigt auf einen Blick, welche Module in dem jeweiligen PORTAL aktiv und damit auch welche APIs potenziell verfügbar sind. Um eine API benutzen zu können, muss die API für das jeweilige Modul von PEIQ eingerichtet werden. Dies geschieht im Rahmen einer Änderungsanfrage.
Interaktive Bedienung – “TRY”-Funktion
Die Dokumentation selbst ist nicht nur rein informativer Natur, sondern bietet darüber hinaus die Möglichkeit, sämtliche lesende (GET) Endpunkt direkt zu testen. Über diese “TRY”-Funktion können also Live-Daten aus dem System direkt im Browser angezeigt werden.
Jeder GET-Endpunkt der Dokumentation hat einen “TRY”-Button. Hierüber können Daten nach den im Front-End vorliegenden Filtern aus dem Live-System abgerufen werden. Bedingung für das Benutzen der Funktion sind gültige API-Credentials.
Diese API-Credentials (Client ID und Client Secret) können
über die Verwaltung von API-Zugängen von berechtigten Benutzer:innen selbst erstellt werden: https://peiq.atlassian.net/wiki/spaces/PUPKB/pages/249168027
bei PEIQ beantragt werden, sofern das Feature API-Konsole nicht aktiviert ist.
Die Autorisierung erfolgt über den Button “GET TOKEN” der jeweiligen Dokumentation. Hier müssen die API-Credentials (Client-ID und Client Secret) über eine Maske eingetragen und bestätigt werden.
Nach gewisser Zeit ist eine erneute Autorisierung der API-Credentials erforderlich, da es zum Ablauf der Autorisierung kommen wird.
Um ein versehentliches Manipulieren der Daten zu verhindern, ist die Benutzung auf die lesenden Endpunkte (GET) beschränkt.
Download der API Dokumentation
Die Dokumentation kann pro Modul oder komplett (über die Modulübersicht) heruntergeladen werden. Die heruntergeladene JSON-Datei kann beispielsweise in REST-Clients importiert werden, um direkt mit der Bedienung zu starten.
Verwandte Seiten
Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/SYsIAw