Die Web API ist eine RESTful-Client-Schnittstelle, mit der Informationen aus der i-net Clear Reports abgerufen und verschiedene Aktionen ausgelöst werden können. Sie bietet außerdem eine grafische Oberfläche, um die verfügbaren Web-API-Erweiterungen schnell zu prüfen, die Dokumentation für jeden Endpunkt zu lesen und sie auszuprobieren.

Die Web-API-Benutzeroberfläche kann vor Endanwendern verborgen werden, um die Sicherheit in Umgebungen zu erhöhen, die den Zugriff auf die eigentlichen API-Schnittstellen dennoch zulassen sollen.

Wenn die Web-API-Benutzeroberfläche aktiviert ist (Standard), kann sie als Modul von der i-net Clear Reports Startseite aufgerufen werden. Die Schnittstelle ermöglicht Benutzern mit der Web-API-Berechtigung und bestimmten Plugin-Berechtigungen das Durchsuchen und den Zugriff auf die API-Endpunkte - und ihre jeweilige Hilfeseite - im Kontext /api.

Mit dem deaktivieren dieser Option wird die Web-API-Benutzeroberfläche deaktiviert. Sie deaktiviert nicht den Zugriff auf die Web-API selbst, wenn sie von anderen Tools, wie curl oder AJAX, verwendet wird.

Hinweis: Dies ist eine globale Option und erlaubt/verweigert den Zugriff für alle Benutzer des i-net Clear Reports-Servers.

Die Web-API-Benutzeroberfläche kann durch Aktivieren dieser Option ausgeblendet werden. Um diese Option zu ändern, muss die Benutzeroberfläche aktiviert sein.

Wenn diese Option deaktiviert ist, wird die Web-API-Anwendung weder auf der Startseite noch im Anwendungsmenü angezeigt. Benutzer können weiterhin auf die Benutzeroberfläche zugreifen, wenn sie Web-API-Endpunkte im Browser verwenden.

Der Zugriff auf die Datei swagger.json ist standardmäßig ohne Authentifizierung aktiviert, so dass Entwickler von ihren Tools aus uneingeschränkten Zugriff haben. Sie können jedoch den öffentlichen Zugriff deaktivieren und ihn auf Web-API-Erweiterungen beschränken, die entweder keine Authentifizierung erfordern oder auf die der Benutzer Zugriff hat. In diesem Fall müssen sich die Benutzer für den Zugriff auf die URL der Swagger-Datei authentifizieren.

Sie können die Swagger-Datei auch über die Web-API-Anwendung exportieren - in diesem Fall werden Sie mit dem Benutzer authentifiziert, mit dem Sie auf die Anwendung zugreifen.