Von der Web-Oberfläche des API Servers aus können Sie:
den API Server konfigurieren
die Swagger-Dokumentation Ihrer API aufrufen
das Web Portal für Betriebsunterstützung öffnen
alle installierten Webanwendungen aufrufen
Um die API Server Web-Oberfläche aufzurufen
Rufen Sie die Web-Adressse (URL) Ihres API Servers in einem Browser auf.
Der API Server legt Daten auf fälschungssichere Weise verschlüsselt auf dem Client ab.
Das Zertifikat wird bei der Installation des API Servers auf dem IIS konfiguriert. Weitere Informationen zur Installation des API Servers finden Sie im One Identity Manager Installationshandbuch.
Weitere Informationen zur Konfiguration der Verschlüsselung finden Sie im One Identity Manager Konfigurationshandbuch für Webanwendungen.
Da der API Server zustandslos ist (stateless), speichern Sie API-Methoden ohne Client-spezifischen Zustand.
Sie dürfen daher beispielsweise keine globalen Variablen definieren oder am Session-Objekt Zustandsdaten hinterlegen. Beim Neustart des API Server-Prozesses werden diese Werte nicht wiederhergestellt.
Nach dem Aktivieren der Routen dürfen Sie die Definitionsobjekte nicht mehr verändern.
Verwenden Sie asynchronen Code beim Definieren von API-Methoden. Damit wird die effiziente Nutzung der Server-Ressourcen unterstützt sowie die System-Performance unter Last verbessert. Die Methoden der API und des zugrundeliegenden Objektmodells setzen diese Asynchronität mithilfe des Task-based Asynchronous Pattern (TAP) um. Weitere Informationen zu TAP finden Sie hier.
Verwenden Sie beim Definieren von API-Methoden NICHT die Methode HttpContext.Current. Die aktuelle HTTP-Anforderung können Sie mit der statischen Methode QBM.CompositionApi.OwinRequestScopeContext.Context.Current abfragen.
Verwenden Sie beim Definieren von API-Methoden, die Daten verändern, NICHT die Methode GET.
In diesem Kapitel finden Sie allgemeine Richtlinien und Konvention, die Sie beim Erstellen einer API beachten müssen.
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
