Logo Online Hilfe www.powerio.com

REST-API

Über die REST API können die Daten eines Projekts von einer externen Anwendung abgerufen werden. Dazu ist ein API-Token nötig, mit dem sich die externe Anwendung authentifiziert. Klicken Sie zum Öffnen des Dialogs im Projektbereich auf das Symbol neben Projekteinstellungen & Tarif und wählen REST API.

Dialog zur Verwaltung von API-Tokens zur Autorisierung der REST-API

Die Dokumentation der REST API kann über den Link API-Beschreibung abgerufen werden. Anschließend wird in einem neuen Browser-Tab die Swagger UI geöffnet. Nach erfolgreicher Authentifizierung können die einzelnen API-Funktionen hier auch getestet werden.

Hinweis: Ein neu erstellter Token muss erst gespeichert werden, bevor er zur Authentifizierung in der Swagger UI genutzt werden kann.

API-Token erstellen

Dialog zum Erstellen eines API-Tokens mit Auswahl der Rolle und einem IP-Filter
Token Ein automatisch generierter Token, der in die Zwischenablage kopiert werden kann
Name Zur Dokumentation, welche Anwendung den Token nutzt
Rolle Legt die Rechte des Tokens fest ('Lesender Zugriff' oder 'Administrator')
IP-Filter Zur zusätzlichen Absicherung kann der Token nur für einen bestimmten IP-Adressbereich zugelassen werden

Achtung: Kopieren Sie den Token in die Zwischenablage und heben Sie diesen gut auf. Der Token ist im Nachgang nicht mehr vollständig einsehbar.