Intrexx Administration API

Funktionsumfang

Die Intrexx Administration API stellt Ihnen ein Set von API-Endpunkten zur Verfügung, mit denen zentrale Aufgaben in Intrexx ausführen können, ohne den Intrexx Portal Manager starten zu müssen.

So können Sie über einen API-Client Portale oder Benutzer anlegen und löschen, Lizenzen einspielen oder Applikationen importieren. Eine vollständige Liste aller API-Endpunkte finden Sie in Abschnitt API-Endpunkte - Erläuterung, Links, Beispiele. Zudem finden Sie die Übersicht der API-Endpunkte in einer Dokumentation im OpenAPI-Standard. Diese wird von einer Swagger-UI-Kompomente dargestellt. Detaillierte Informationen hierzu finden Sie in Abschnitt Interaktive Swagger-Dokumentation.

Abgrenzung "Application API" und "Administration API"

In Intrexx stehen Ihnen zwei umfangreiche API-Funktionalitäten zur Verfügung: die Intrexx Application API und die Intrexx Administration API. Bei der Application API können Sie eigene API-Endpunkte für Intrexx-Applikationen erstellen. Bei der Administration API steht Ihnen ein definiertes Set von API-Endpunkten zur Verfügung, das Ihnen zentrale Funktionen für die Konfiguration von Intrexx bereitstellt.

• Intrexx Administration API

• Intrexx Application API

Zielgruppe

Die Intrexx Administration API eignet sich besonders für Administratoren oder erfahrene Intrexx-Anwender, die mehrere Intrexx-Instanzen verwalten. Wenn Sie beispielsweise neue Benutzer für ein Portal anlegen oder eine neue Lizenz einspielen möchten, können Sie zu diesem Zweck eigene Anwendungen bzw. Skripte erstellen und die entsprechenden Aktionen über die API-Endpunkte ausführen.

Sie finden eine Reihe von Skript-Beispielen auf GitHub unter dem folgenden Link: https://github.com/UnitedPlanet/intrexx-sample-admin-api.

Sie gelangen auf die einzelnen Skript-Beispiele auch, wenn Sie der Seite API-Endpunkte - Erläuterung, Links, Beispiele den Links unterhalb der jeweiligen Endpunkte folgen.

Spezifikation

Die Intrexx Administration API folgt der OpenAPI Spezifikation.

Architektur

Bei der Intrexx Administration API handelt es sich um ein API Gateway. Sie ist Teil der Intrexx-Instanz und muss installiert und anschließend gestartet werden.

Nach der Installation befinden sich alle mit der Intrexx Administration API zusammenhängenden Dateien, Bibliotheken und Skripte im Verzeichnis <intrexx-installationsverzeichnis>\admin-api und den darin enthaltenen Unterverzeichnissen.

Detaillierte Informationen zur Installation der Intrexx Administration API finden Sie in Abschnitt Installation.