API-User

Die API-User in qualido manager werden benutzt, um die Authentifizierung für die qualido REST-API zu realisieren. Hier können Sie API-User anlegen und Rechte zuweisen. Das qualido API-Dokument im OpenAPI-Format enthält die Liste der Ressourcen, die verfügbar sind, und die Operationen, die für diese Ressourcen aufgerufen werden können. Der Reiter ist nur für Superadministratoren verfügbar.

Infografik zeigt qualido REST-API-Dokumentation mit verfügbaren Ressourcen und Operationen für Benutzer- und Gruppenverwaltung im standardisierten OpenAPI-Format

Schaltflächen in der Werkzeugleiste

API-User anlegen: Mit dieser Schaltfläche können Sie einen API-Benutzer anlegen, der höchstens drei Monate lang auf die qualido-OpenAPI-Dienste zugreifen darf [1]. Nach dem Speichern des Dokuments öffnet sich ein Dialogfenster, in dem Sie den Zugriffstoken zur qualido-API-Verbindung kopieren können. Bitte bewahren Sie die kopierten Zugangstoken an einem sicheren Ort auf, wie z.B. in einem Passworttresor.

Bearbeiten: Diese Schaltfläche ermöglicht es Ihnen, die Bezeichnung des API-Users und das Zugriffszeitintervall auf qualido-API zu ändern.

Rechte zuweisen: Diese Schaltfläche ermöglicht es einem API-User [2], Portale und Gruppen, administrative Rechte in Geräte-, Dokumenten-, Gruppen-, Meldungs- und Mitarbeiterverawaltung und Verantwortlichkeiten (im Ereignismanagement) zu definieren.

Löschen: Diese Schaltfläche ermöglicht die Entfernung eines Api-Users aus der Liste.

API-Token erneuern: Diese Schaltfläche ermöglicht die Erneuerung des Bearer-Tokens für den ausgewählten API-User. Bitte beachten Sie, dass bereits aktive Schnittstellen ohne Anpassung nicht mehr laufen können.

Info zum API-Token: Mit dieser Schaltfläche wird das Informationsfenster zum Bearer-Token geöffnet.

API-Dokumentation: Über die Schaltfläche können Sie das qualido API-Dokument im OpenAPI-Format erreichen. Das Dokument gibt die Liste der Ressourcen in administrativen und Mitarbeiteransichten an, die in der REST-API verfügbar sind, und die Operationen (GET, POST, PUT und DELETE), die für diese Ressourcen aufgerufen werden können. Für die administrativen Endpunkte benötigt den API-User entsprechende Verwaltungsrechte.

Verwandte Themen