Chat now with support
Chat with Support

Identity Manager 9.2.1 - API-Entwicklungshandbuch

Über dieses Handbuch Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Eigene APIs implementieren ImxClient-Kommandozeilenprogramm

API Server-Web-Oberfläche aufrufen

Von der Web-Oberfläche des API Servers aus können Sie:

  • das Web Portal öffnen

  • das Kennwortrücksetzungsportal öffnen

  • das Web Portal für Betriebsunterstützung öffnen

  • das Administrationsportal öffnen, um den API Server und die Webanwendungen zu konfigurieren (siehe One Identity Manager Konfigurationshandbuch für Webanwendungen)

  • alle weiteren installierten Webanwendungen öffnen

Um die API Server Web-Oberfläche aufzurufen

  • Rufen Sie die Web-Adressse (URL) Ihres API Servers in einem Browser auf.

Verschlüsselung

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.

Allgemeine Hinweise zur Programmierung eigener API-Methoden

  • 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.

Automatische Prüfung der Eindeutigkeit von API-Routen

Der API Server prüft automatisch beim Starten, ob API-Routen eindeutig sind. Sobald der API Server feststellt, dass nicht-eindeutige URL-Pattern registriert wurden, wird eine entsprechende Fehlermeldung mit dem Fehlercode ApiServer0037 erzeugt.

Um das Problem zu lösen, müssen die API-Routen in einer anderen Reihenfolge registriert werden, indem Sie die Eigenschaft SortOrder der entsprechenden API-Routen anpassen. Die Eigenschaft SortOrder bestimmt, in welcher Reihenfolge die URL-Pattern auf die URL einer API-Anfrage angewendet werden. API-Pattern mit niedrigerer SortOrder werden zuerst angewendet.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating