Chat now with support
Chat mit Support

Identity Manager 8.2 - 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

Kompilierungszweige löschen

Um Kompilierungszweige zu löschen

  1. In der Menüleiste klicken Sie Ansicht > Startseite.

  2. Auf der Startseite klappen Sie den Bereich Kompilierungszweige aus.

  3. Im Bereich Kompilierungszweige klicken Sie (Kompilierungszweige verwalten).

  4. Im Dialogfenster Kompilierungszweige verwalten klicken Sie in der Liste auf den Kompilierungszweig, den Sie löschen möchten.

  5. Klicken Sie (Löschen).

  6. Im Dialogfenster Löschen? bestätigen Sie die Abfrage mit Ja.

Verwandte Themen

API testen

Sie können jederzeit die Funktionalität Ihrer API lokal auf Ihrem PC testen.

Um Ihre API lokal zu testen

  1. In der Menüleiste klicken Sie Ansicht > Startseite.

  2. Auf der Startseite klappen Sie den Bereich Self-hosted API Server aus.

  3. Im Eingabefeld Anfangsoptionen geben Sie die Optionen für den Start der API ein.

    TIPP: Alternativ können Sie auch Befehle aus der Liste auswählen, die Sie früher bereits verwendet haben.

  4. Klicken Sie Start.

    Die API wird kompiliert und ist anschließend lokal verfügbar. Die entsprechende Web-Adresse wird neben dem Status angezeigt. Klicken Sie die Adresse, um Sie direkt im Browser zu öffnen.

Verwandte Themen

C#-Projekte mit dem API Designer verbinden

Um eine API als C#-Projekt mit externen Programmen (beispielsweise mit Visual Studio) bearbeiten zu können, müssen Sie 3 Schritte durchführen:

  1. Sie verknüpfen Ihr API Designer-Projekt mit einem neuen oder bestehenden C#-Projekt.

  2. Sie bearbeiten das C#-Projekt in einem externen Programm.

  3. Sie öffnen das C#-Projekt wieder im API Designer und speichern es im API-Projekt.

Um das API Designer-Projekt mit einem C#-Projekt zu verknüpfen

  1. In der Menüleiste klicken Sie Ansicht > Startseite.

  2. Auf der Startseite klappen Sie den Bereich C#-Entwicklung aus.

  3. Im Bereich C#-Entwicklung führen Sie einen der folgenden Aktionen aus:

    • Um das API Designer-Projekt als neues C#-Projekt zu exportieren und zu verknüpfen, klicken Sie (C#-Projekt exportieren). Navigieren Sie zu dem Ordner, in den Sie die Inhalte Ihres API Designer-Projekts als C#-Projekt exportieren möchten und klicken Sie OK.

    • Um das API Designer-Projekt mit einem bestehenden Projekt zu verknüpfen, klicken Sie (C#-Projekt laden).

    Der API Designer wird mit dem C#-Projekt verknüpft.

Um das C#-Projekt in externen Programmen zu bearbeiten

  1. In der Menüleiste klicken Sie Ansicht > Startseite.

  2. Auf der Startseite klappen Sie den Bereich C#-Entwicklung aus.

  3. Im Bereich C#-Entwicklung klicken Sie auf Projektdatei: <Pfad zum C#-Projekt>.

    Das Projekt öffnet sich in dem Programm, das mit der Projektdatei verknüpft ist.

    TIPP: Um den Projektordner direkt zu öffnen, klicken Sie (Zugehörigen Ordner öffnen).

  4. Bearbeiten Sie das Projekt in dem externen Programm. Sie können beispielsweise API-Dateien erstellen, ändern oder löschen.

Um Änderungen wieder in das API Designer-Projekt zurückzuspielen

  1. Öffnen Sie den API Designer.

  2. In der Menüleiste klicken Sie Ansicht > Startseite.

  3. Auf der Startseite klappen Sie den Bereich C#-Entwicklung aus.

  4. Im Bereich C#-Entwicklung klicken Sie (C#-Projekt mit Basis abgleichen).

    Sie sehen nun die Objekte, die Sie außerhalb des API Designers geändert haben.

  5. Wählen Sie aus den Auswahllisten neben den geänderten Objekten die Aktionen die Sie für das API Designer-Projekt durchführen möchten.

    Statusmeldung

    Beschreibung

    Aktionen

    Neue C#-Datei

    Eine neue API-Datei wurde im C#-Projekt erstellt.

    API-Datei hinzufügen: Fügt die C#-Datei, die Sie im externen Programm erstellt haben, Ihrem API Designer-Projekt als API-Datei hinzu.

    Datei löschen: Löscht die C#-Klasse im C#-Projekt.

    Neue API-Datei

    Eine neue API-Datei wurde im API Designer-Sharp-Projekt erstellt.

    C#-Datei hinzufügen: Fügt die API-Datei, die Sie im API Designererstellt haben, Ihrem C#-Projekt als C#-Datei hinzu.

    API-Datei löschen: Löscht die API-Datei im API Designer-Projekt.

    API-Datei ist neuer

    Eine API-Datei wurde im API Designer-Projekt geändert.

    Update: Übernimmt die Änderungen an der API-Datei aus dem API Designer-Projekt in das C#-Projekt.

    Änderungen rückgängig machen: Macht die Änderungen, die Sie in Ihrem API Designer-Projekt an der API-Datei gemacht haben, rückgängig.

    C#-Datei ist neuer

    Eine API-Datei wurde im C#-Projekt geändert.

    Update: Übernimmt die Änderungen an der API-Datei aus dem C#-Projekt in das API Designer-Projekt.

    Änderungen rückgängig machen: Macht die Änderungen, die Sie in Ihrem C#-Projekt an der API-Datei gemacht haben, rückgängig.

  6. Aktivieren Sie die Kontrollkästchen neben Objekten, für die Sie die gewählten Aktionen durchführen möchten.

    TIPP: Um alle Objekte aus- oder abzuwählen, aktivieren Sie das Kontrollästchen Alle auswählen/abwählen über der Liste.

  7. Klicken Sie (Ausgewählte Aktionen anwenden).

API-Projekte

Ein API-Projekt stellt die eigentliche Anwendung, die API selbst, dar.

Sie können API-Dateien, die Sie erstellt haben, in einem API-Projekt zu einer logischen Anwendung zusammenfassen. Das API-Projekt stellt dabei die Konfiguration zur Verfügung. Zu einem API-Projekt gehört die Authentifizierung an der Datenbank.

Verwandte Themen
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen