Web-API

Der INETAPP-Server stellt eine Vielzahl von Funktionen über eine Web-API Schnittstelle zur Verfügung. Dazu benötigen die Benutzer die Web API-Zugriffs-Berechtigung. Darüber hinaus kann es erforderlich sein, dass Benutzer auch Berechtigungen für bestimmte weitere Funktionen im System haben müssen.

Die folgende Liste von API-Endpunkten steht dem aktuellen Benutzer zur Verfügung:

WEB-API-EXTENSIONS-LIST

Anfragebereich

Anfragen können in gewissem Umfang angepasst werden: Benutzer können die HTTP-Methode (POST, GET, HEAD ...) festlegen, dynamische Teile der URL aktualisieren, z.B. IDs, die bestimmte WebAPI-Kontexte ansprechen, Anfrage-Header sowie das Anfrage-JSON setzen.

Der URL-Pfad ist in der Regel nicht editierbar, mit Ausnahme der Teile, die z.B. IDs akzeptieren. Wenn Sie ID-Teile bearbeiten und in der Seitennavigation weiter navigieren, werden diese ID-Teile für die aktuelle Seite gespeichert, so dass Sie nahtlos vor- und zurückspringen können. Das erneute Senden einer Anfrage erfolgt über die Schaltfläche Senden.

Über das Optionsmenü neben der Schaltfläche Senden können Sie den Vorschaumodus aktivieren, den JSON-Dateneingabebereich und den Bereich für zusätzliche HTTP Anfrage-Header einblenden.

Benutzerdefinierte HTTP Header

Zusätzliche Benutzerdefinierte HTTP Header können mit einer Anfrage mitgeschickt werden, wenn ein WebAPI-Endpunkt dies erfordert. Dies können z.B. Bearer Token sein.

JSON-Anfragedaten senden

Der Bereich JSON-Anfragedaten senden ermöglicht das Mitsenden einer JSON-Anfrage, die für einen bestimmten WebAPI-Endpunkt erforderlich ist. Hinweise auf das benötigte JSON werden in der Regel auf der Hilfeseite unterhalb des Antwortbereichs gegeben.

Hinweis: Einige HTTP-Methoden unterstützen das Senden von JSON-Daten nicht. Der Bereich ist dann deaktiviert.

Vorschau-Modus

Der Vorschaumodus ist eine Option im Antwortfenster der Web API Oberfläche. Wenn er aktiviert ist, sendet er zusätzliche Informationen an den Server, der dann entscheiden kann, das Ausführen eines bestimmten Befehls nur zu simulieren.

Ob ein Befehl mit tatsächlichen Daten im Vorschaumodus ausgeführt wird, hängt stark vom jeweiligen Befehl ab. Normalerweise ist der Vorschaumodus für potenziell destruktive Befehle wie Löschen sinnvoll.

Antwortbereich

Der Antwortbereich der Web API Oberfläche besteht aus der Anfrage-URL, dem Antwortstatus-Code und der Nachricht. Ein Optionsfeld ermöglicht das Umschalten des Vorschaumodus (standardmäßig eingeschaltet).

Wenn die Antwortstatus-Nachricht nicht gesetzt wurde, wird eine generische Nachricht angezeigt (drei Punkte: ...). Dies geschieht normalerweise, wenn ein API-Punkt binäre Daten zurückschickt.

Hinweis: Binäre Datenantworten können dazu führen, dass anstelle einer JSON-Antwort (oder anderer verfügbarer Formate) ein Download-Button angezeigt wird. Die Anfrage wird beim klick auf die Download Schaltfläche erneut ausgelöst. Das bedeutet, dass der Befehl auf dem Server zweimal ausgeführt wird.

Authentifizierung

Anfragen an die Web-API erfordern eine ordnungsgemäße Authentifizierung. Viele der vorinstallierten Authentifizierungsanbieter unterstützen das BASIC-Authentifizierungsschema.

# REQUEST
POST /api HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
Content-Type: application/json

Authentifizierte Sitzungen

Jede Sitzung verbraucht Speicher und verlangsamt den Server.

Bei Verwendung des BASIC-Authentifizierungsschemas wird eine Sitzung erstellt, und es ist wichtig, diese Sitzung für nachfolgende Anfragen wiederzuverwenden. Andernfalls können sich unnötige Sitzungen ansammeln, was den Server verlangsamen kann. Um dies zu verhindern, steht ein zusätzliches Defender Plugin zur Verfügung, das die Anzahl der innerhalb eines bestimmten Zeitraums erstellten Sitzungen begrenzt und bei Überschreitung den Benutzer und die IP für die Anmeldung sperrt.

Lösung: Um die Erstellung unnötiger Sitzungen zu vermeiden, können Sie entweder die Sitzung wiederverwenden, indem Sie das Sitzungs-Cookie mit jeder Anfrage senden, oder das Token-Authentifizierungs-Plugin verwenden. Mit dem Token-Authentifizierungs-Plugin meldet sich der Benutzer bei jeder Anfrage an, ohne eine Sitzung zu erstellen, wodurch die Anfragen zustandslos werden.