Chat now with support
Chat mit Support

Identity Manager 8.1 - API Designer Benutzer-und Entwicklungshandbuch

Der API Designer Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Schnellstart – Eine API erstellen Arbeiten mit dem API Designer
API Designer starten Projekttypen Benutzeroberfläche Globale Einstellungen Datenbankobjekte Änderungen kennzeichnen Suchen und Ersetzen Mehrsprachige Texte Datenbankabfragen verwalten Tabreiter verwalten Layouts verwalten Änderungshistorie anzeigen (Befehlsliste) Lesezeichen API kompilieren Versionen verwalten (Kompilierungszweige) API testen C#-Projekte mit dem API Designer verbinden
API-Projekte API-Dateien API Server ImxClient-Kommandozeilenprogramm

Der API Designer

Mit dem API Designer können Sie auf schnellstem Wege eine REST-API (Representational State Transfer Application Programming Interface) erstellen, dokumentieren, kompilieren und veröffentlichen. Diese API basiert auf der OpenAPI-Spezifikation und dem One Identity Manager-Datenbankmodell.

Vorteile des API Designers auf einem Blick:

  • Einfache und schnelle Bedienung

  • Die fertige API "versteht" das One Identity Manager-Datenbankmodell.

  • Änderungen an der API sind nachvollziehbar.

  • Unterstützt Prinzipien eines guten API-Designs

  • OpenAPI-Unterstützung: APIs, die Sie mithilfe des API Designers erstellen, basieren grundsätzlich auf der OpenAPI-Spezifikation. Dies ermöglicht Ihnen auf weitere Hilfsmittel zuzugreifen:

    • Swagger: Verwenden Sie Swagger, um Code, Dokumentation und Testfälle zu erstellen.
    • Postman: Verwenden Sie Postman, um die verschiedenen API-Methoden Ihrer API zu testen.

Grundlagen der API-Entwicklung

Hauptbestandteil einer mit dem API Designer erstellten API sind Dateien und Projekte.

Grundsätzliches zu API-Dateien:

  • Mit API-Dateien kann man Daten an die Anwendung senden oder Daten von der Anwendung abfragen.

  • Eine API-Datei kann zu mehr als einem Projekt gehören.

Grundsätzliches zu API-Projekten:

  • API-Projekte fassen mehrere API-Dateien in logische Abschnitte zusammen. Das API-Projekt stellt dabei die Konfiguration zur Verfügung.

Verwandte Themen

Beispiele und Hilfe – Software Development Kit

Um Ihnen die Entwicklung Ihrer API mit dem API Designer 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.

Schnellstart – Eine API erstellen

Nachfolgend finden Sie eine grobe Auflistung der Schritte, die Sie im API Designer durchführen müssen, um eine API zu erstellen.

  1. Starten Sie den API Designer.

  2. Erstellen Sie API-Dateien (in diesen können Sie beispielsweise eine API-Methode definieren).

  3. Erstellen Sie ein API-Projekt.

  4. Konfigurieren Sie die Authentifizierung des API-Projektes (unter anderem Single Sign-on).

  5. Weisen Sie die erstellten API-Dateien dem API-Projekt zu.

  6. Testen Sie die API.

  7. Kompilieren Sie die API.

  8. Übertragen Sie die Änderungen in die Datenbank.

Verwandte Themen
Self-Service-Tools
Knowledge Base
Benachrichtigungen und Warnmeldungen
Produkt-Support
Software-Downloads
Technische Dokumentationen
Benutzerforen
Videoanleitungen
RSS Feed
Kontakt
Unterstützung bei der Lizenzierung
Technische Support
Alle anzeigen
Verwandte Dokumente