Allgemeines, Funktionsumfang
Wenn Sie beispielsweise eine Applikation zur Zeiterfassung erstellt haben, so können Sie per API auf die Datengruppe(n) zugreifen und sich auf einer Smartphone-App, die die API-Endpunkte konsumiert, die Zeitkonten anzeigen lassen.
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.
Prozesse
Im Folgenden finden Sie eine Beschreibung der zentralen Schritte, die Sie ausführen müssen, damit Sie eigene API-Endpunkte erstellen und einsetzen können.
|
|
Erstellen Sie zunächst wie gewohnt eine Applikation. |
|
Erstellen Sie anschließend den gewünschten API-Endpunkt. Hierfür müssen Sie im Hauptmenü unter "Ansicht" das Kontrollkästchen "API-Endpunkte" aktiviert haben. Sie können API-Endpunkte für Datengruppen, Prozesse und Groovy-Skripte erstellen. Dabei stehen Ihnen die Methoden GET, POST, PATCH und DELETE zur Verfügung. |
|
|
Im nächsten Schritt vergeben Sie Berechtigungen für jeden einzelnen API-Endpunkt. Sie können Rechte auf Applikationsebene vergeben. Dabei wählen Sie Benutzer aus, die auf den entsprechenden API-Endpunkt zugreifen dürfen. |
|
|
Alternativ bzw. ergänzend zu den Berechtigungen auf Applikationsebene können Sie Berechtigungen mit Hilfe von API-Keys vergeben. Dafür ist es zunächst erforderlich, einen API-Key zu erstellen und anschließend diesen einem oder mehreren API-Endpunkten und einem Benutzer zuzuweisen. |
|
|
Mit diesen Schritten haben Sie die Voraussetzungen geschaffen, damit ein API-Konsument auf einen API-Endpunkt zugreifen kann. Um den Zugriff auf den API-Endpunkt (Request) auszuführen, stehen über Kontextmenüs hilfreiche Funktionen zur Verfügung wie das Kopieren der API-URL oder des API-Keys. |
|
|
Schließlich können Sie eine Swagger Dokumentation bzw. ein Swagger File im .yaml-Format erstellen. Dieses können Sie zusammen mit den API-Keys beispielsweise einem externen Dienstleister übergeben, der eine App für ein Smartphone für Sie erstellt. |
Zielgruppe und Vorkenntnisse
Das Feature "Application API" und auch die zugehörige Onlinehilfe richten sich an Anwender, die über ein Grundverständnis der API-Entwicklung verfügen. Die Application API folgt der Open API Spezifikation. Gegebenenfalls sollten Sie sich mit dieser vertraut machen.
Wie Sie die Onlinehilfe zur Application API lesen können
Im ersten Abschnitt Application API-Endpunkte erstellen finden Sie allgemein gehaltene Informationen zum Erstellen von Application API-Endpunkten. Sie finden eine Übersicht über die einzelnen Dialoge und deren Funktionen, allgemeine Informationen zu Pfad- und Query-Paramtern und zum Aufbau der API-URL. Wenn Sie sich (zunächst) mit Grundlagen der API-Endpunkt-Erstellung in Intrexx vertraut machen möchten und allgemeine Informationen zur API-Erstellung benötigen, dann ist es hilfreich, wenn Sie diesen Abschnitt als erstes lesen.
Sie können aber auch direkt mit den Abschnitten zum Erstellen der einzelnen Endpunkte einsteigen. Dort finden Sie für jeden Endpunkt-Typ detaillierte Schritt-für-Schritt-Anleitungen. Diese führen Sie durch die einzelnen Dialoge und erläutern, welche Angaben Sie jeweils eingeben bzw. auswählen müssen.
Die Schritt-für-Schritt-Anleitungen finden Sie in folgenden Abschnitten:
Die darauf folgenden Abschnitte zur Vergabe von Berechtigungen (Berechtigungen vergeben), zum Erstellen von API-Keys (API-Keys erstellen und verwalten) und zum Ausführen von Requests (Requests ausführen) sollten in jedem Fall von Ihnen gelesen werden, um die von Ihnen erstellten API-Endpunkte funktional einsetzen zu können.
Der Abschnitt Swagger-Dokumentation erzeugen ist besonders hilfreich, wenn Sie ein OpenAPI-File im .yaml-Format erzeugen und gegebenenfalls mit einem Dienstleister austauschen möchten.
Weiterführende Informationen
Im Folgenden finden Sie einige Links, die Ihnen helfen können, sich mit den Grundlagen der API-Entwicklung und den dazugehörigen Standards vertraut zu machen:
Senden Sie uns eine E-Mail