Chat now with support

Live-Hilfe anfordern
Registrierung abschließen

Anmelden

Preisinformationen anfragen

Vertrieb kontaktieren

Wir führen zurzeit Wartungsarbeiten an unserer Website durch. Funktionen, für die eine Anmeldung erforderlich ist, sind vorübergehend nicht verfügbar. Wenn Sie umgehende Hilfe bei einem Problem benötigen, wenden Sie sich an den technischen support

Identity Manager 9.2.1 - API-Entwicklungshandbuch

Inhaltsnavigation

Über dieses Handbuch Grundlagen der API-Entwicklung

Grundlagen des API Servers

Allgemeine Informationen zum API Server API Server-Web-Oberfläche aufrufen Verschlüsselung Allgemeine Hinweise zur Programmierung eigener API-Methoden Automatische Prüfung der Eindeutigkeit von API-Routen

Richtlinien und Konventionen

Abarbeitung einer Anfrage an den API Server Authentifizierung

Authentifizierung konfigurieren Authentifizierung (primär) Abmeldung

Sitzungsstatus und Sicherheitstoken

Sitzungsstatus abfragen

API-Methoden

Entity-Methoden

Hinweise Ergebnisse einschränken Sortierung Filterung Gruppierung Hierarchische Datenstrukturen Abfrage zusätzlicher Parameter Typsichere Klassen

Benutzerdefinierte Methoden SQL-Methoden WebSocket-Methoden

HTTP-Methoden Datumsformate Parameterformate

Pfad-Parameter Abfrage-Parameter

Antwortformate Antwortcodes Deadlocks vermeiden Erreichbarkeit des API Servers abfragen

Beispiele und Hilfe – Software Development Kit Eigene APIs implementieren

API-Plugins verwalten

API-Plugins erstellen API-Plugins bearbeiten TypeScript API-Clients kompilieren

APIs zu One Identity-API-Projekten hinzufügen API-Projekte erstellen APIs zu eigenen API-Projekte hinzufügen

ImxClient-Kommandozeilenprogramm

ImxClient-Kommandozeilenprogramm starten ImxClient-Kommando-Übersicht

check-translations compile-api compile-app connect edit-config fetch-files get-apistate get-filestate help inject-package install-apiserver push-files repl run-apiserver start-update workspace-info

Deadlocks vermeiden

Grundlagen der API-Entwicklung > Richtlinien und Konventionen > Deadlocks vermeiden

Bei der API-Entwicklung wird viel asynchroner Code mit async/await-Konstrukt geschrieben. Um sogenannte Deadlocks (Verklemmungen) zu verhindern, verwenden Sie für jedes await-Schlüsselwort die Methode ConfigureAwait(false).

Weitere Informationen finden Sie hier und hier.

Erreichbarkeit des API Servers abfragen

Grundlagen der API-Entwicklung > Richtlinien und Konventionen > Erreichbarkeit des API Servers abfragen

Sie können den Zustand des API Servers abfragen, indem Sie eine eigene API-Methode erstellen, die die URL imx/ping aufruft. Diese Methode erfordert keine vorherige Authentifizierung und gibt den Antwortcode 200 (OK) zurück, wenn der API Server läuft.

Beispiele und Hilfe – Software Development Kit

Um Ihnen die Entwicklung Ihrer API einfacher zu gestalten, stellt Ihnen One Identity ein Software Development Kit (SDK) mit vielen kommentierten Code-Beispielen zur Verfügung.

Das SDK finden Sie unter auf dem Installationsmedium im Verzeichnis QBM\dvd\AddOn\ApiSamples.

Eigene APIs implementieren

Um eigene APIs zu implementieren, können Sie API-Plugins erstellen.

Der API Server lädt alle DLLs, auf die das Namensschema *.CompositionApi.Server.PlugIn.dll passen, und stellt die darin enthaltenen API-Definitionen zur Verfügung.

Um Ihre eigene APIs zu implementieren, stehen Ihnen folgende Möglichkeiten zur Verfügung:

Sie können eine API zu einem One Identity-API-Projekt hinzufügen (siehe APIs zu One Identity-API-Projekten hinzufügen).
Sie können ein eigenes API-Projekt erstellen (API-Projekte erstellen).
Sie können eine API zu einem Ihrer eigenen bestehenden API-Pojekte hinzufügen (siehe APIs zu eigenen API-Projekte hinzufügen).