APIs-Seite im Jitterbit API Manager

Einführung

Die Seite APIs ist die Hauptseite des API Manager. Sie ermöglicht Harmony-Organisationsadministratoren, drei Arten von APIs zu verwalten:

• Custom APIs
• OData-Services
• Proxy APIs

APIs können mithilfe des APIM AI Assistant mit natürlichsprachlichen Eingaben oder manuell über die Konfigurationsbildschirme erstellt werden.

Mitglieder einer Rolle mit Lese-Umgebungszugriff können nur die APIs in dieser Umgebung anzeigen. Mitglieder einer Rolle mit Schreib-Umgebungszugriff haben Schreibzugriff in dieser Umgebung.

Für den Zugriff auf die Seite APIs verwendet man das Menü Harmony-Portalmenü und wählt API Manager > APIs.

APIs-Seitenkopfzeile

Die Kopfzeile oben auf der Seite APIs enthält diese Steuerelemente:

• Basis-API-URL: Die Basis-API-URL der Harmony-Organisation. Klicken Sie auf das Symbol Kopieren, um die URL in die Zwischenablage zu kopieren. (Eine Bestätigung der Aktion wird angezeigt.)

• Verwendete Custom-API-URLs: Die Anzahl der derzeit verwendeten Custom-API-URLs aus der Gesamtanzahl der von der Abonnement-Organisationen zulässigen Custom-API-URLs. Derzeit verwendete API-URLs umfassen solche, die von veröffentlichten Custom APIs und OData-Services sowie deren veröffentlichten Klonen verwendet werden. Entwürfe zählen nicht als verwendete API-URLs.

• Verwendete Proxy-API-URLs: Die Anzahl der derzeit verwendeten Proxy-API-URLs aus der Gesamtanzahl der von der Abonnement-Organisationen zulässigen Proxy-API-URLs. Derzeit verwendete Proxy-API-URLs umfassen solche, die von veröffentlichten Proxy APIs und deren veröffentlichten Klonen verwendet werden. Entwürfe zählen nicht als verwendete API-URLs.

• Suchen: Geben Sie Text in das Suchfeld ein, um die in der Listenansicht oder Kartenansicht angezeigten APIs sofort zu filtern. Die Suche gleicht den eingegebenen Text mit dem Inhalt der aktuellen Spalten der Tabelle oder der Karten ab. Bei der Suche wird nicht zwischen Groß- und Kleinschreibung unterschieden.

  Die Steuerelemente neben dem Suchfeld ermöglichen es, erweiterte Kriterien zu erstellen, zu speichern und wiederzuverwenden:

  • Abfrage speichern: Öffnet das Dialogfeld Neuen Filter erstellen, um die derzeit mit Erweiterte Filter oder Mit Skript suchen angewendeten Kriterien als benannte Abfrage zu speichern, die später wiederverwendet werden kann. Direkt in das Suchfeld eingegebener Text ist nicht in einer gespeicherten Abfrage enthalten. Das Dialogfeld hat die folgenden Felder:

    • Filtername: Ein erforderlicher Name für die gespeicherte Abfrage. Ein Standardname (z. B. New Query_47102) ist vorausgefüllt.

    • Abfrage: Die aktuellen Suchkriterien, vorausgefüllt mit der gleichen criterion=value;-Syntax wie Mit Skript suchen. Bei Bedarf direkt bearbeiten.

    • Spalten: Wählen Sie, welche Spalten angezeigt werden sollen, wenn die gespeicherte Abfrage angewendet wird. Wählen Sie Alle Spalten, um jede Spalte einzuschließen, oder wählen Sie einzelne Spalten. Der API-Name ist immer enthalten und kann nicht abgewählt werden.

    Klicken Sie auf Speichern und suchen, um die Abfrage zu speichern und sofort anzuwenden, oder auf Abbrechen, um das Dialogfeld zu schließen, ohne zu speichern.

  • Gespeicherte Abfragen: Klicken Sie, um Ihre gespeicherten Abfragen anzuzeigen. Wählen Sie eine gespeicherte Abfrage, um sie anzuwenden, oder verwenden Sie die Symbole Bearbeiten oder Löschen, um eine gespeicherte Abfrage zu verwalten.

• Mit Skript suchen: Gibt deine Suchkriterien direkt in das Suchfeld ein, indem du die Syntax criterion=value; verwendest (zum Beispiel apiName=Customers;). Kombiniere mehrere Kriterien in derselben Suche, indem du sie mit einem Semikolon (;) trennst. Verwende das Platzhalterzeichen * oder % im Wert eines Kriteriums, um eine beliebige Anzahl von Zeichen abzugleichen. Zum Beispiel apiName=cus*; oder apiName=cus%;.

• Erweiterte Filter: Öffnet ein Fenster zum Erstellen einer Suche mit diesen integrierten Kriterien:

  • API-Name
  • Typ
  • Status
  • Gruppe
  • Umgebung
  • Service-Root
  • Benutzerrolle
  • Gateway
  • Sicherheitsprofil
  • Zuletzt bearbeitet
  • Veröffentlicht von
  • Zuletzt veröffentlicht

  Für alle Kriterien außer Zuletzt bearbeitet und Zuletzt veröffentlicht klickst du auf die Operatorsteuerung =, um Gleich oder Nicht gleich auszuwählen, und wählst oder gibst dann einen Wert zum Abgleichen ein. Für Zuletzt bearbeitet und Zuletzt veröffentlicht klickst du auf das Datumsfeld, um einen relativen oder absoluten Datumsbereich auszuwählen.

  Klicke auf Suchen, um die Kriterien anzuwenden, oder auf Zurücksetzen, um das Fenster zu löschen, ohne es anzuwenden. Wenn du zu Mit Skript suchen wechselst, werden die aktuell angewendeten Kriterien in das entsprechende Skript konvertiert.

  Kriterien, die mit Erweiterte Filter angewendet werden, erscheinen als beschriftete Pilllen neben dem Suchfeld (zum Beispiel API-Name (1)), wobei alle zusätzlichen angewendeten Kriterien ab dem ersten in einer Mehr-Pille zusammengefasst werden, die die Gesamtzahl anzeigt. Klicke auf das -Symbol auf einer Pille, um dieses Kriterium zu entfernen. Ob mit Erweiterte Filter oder Mit Skript suchen angewendet, klicke auf Filter löschen, um alle angewendeten Kriterien zu entfernen und zur Standardliste der APIs zurückzukehren.

  Hinweis

  Erweiterte Filter können nicht gleichzeitig mit einer einfachen Textsuche verwendet werden. Während Erweiterte Filter-Kriterien angewendet sind, filtert direkt in das Suchfeld eingegebener Text die Liste nicht. Klicke auf Filter löschen, um zur einfachen Textsuche zurückzukehren.

  Falls keine APIs den angewendeten Suchkriterien entsprechen, zeigt die Tabellen- oder Kartenansicht eine Meldung an, die angibt, dass keine übereinstimmenden Elemente gefunden wurden.

• Ansicht: Klicke auf die -Listenansicht oder -Kartenansicht, um das Format zu wechseln, in dem APIs auf dieser Seite angezeigt werden. Beim nächsten Laden der APIs-Seite wird die zuletzt ausgewählte Ansicht vorausgewählt.

• Alles herunterladen: Lädt die Details aller ausgewählten APIs als CSV-Datei herunter. Diese Option ist verfügbar, wenn eine oder mehrere APIs ausgewählt sind. Klicke, um das Dialogfeld API-Details herunterladen zu öffnen, in dem du zusätzliche Felder auswählen und mit deren Reihenfolge ändern kannst. Einige Felder sind vorausgewählt und können nicht entfernt werden. Klicke auf Herunterladen, um die Datei zu speichern.

• API importieren: Öffnet den API-Importbildschirm, auf dem du APIs im APK-Format importieren kannst, einschließlich der mit benutzerdefinierten APIs verknüpften Studio-Projekte, wenn die Datei diese enthält (siehe APIs exportieren und importieren).

• API exportieren: Öffnet den API-Exportbildschirm, auf dem du ausgewählte APIs im APK-Format exportieren kannst, optional einschließlich der mit benutzerdefinierten APIs verknüpften Studio-Projekte (siehe APIs exportieren und importieren).

• Neu: Klicke, um eine der folgenden Optionen auszuwählen:

  • Mit KI erstellen: Öffnet den APIM-Assistenten zum Erstellen einer API mit Anfragen in natürlicher Sprache. Weitere Informationen findest du unter Verwenden des KI-Assistenten.

    Hinweis

    Um den APIM-KI-Assistenten zu verwenden, muss deine Harmony-Lizenz die APIM-KI-Assistenten-Option enthalten. Kontaktiere deinen Customer Success Manager (CSM), um diese Option zu deiner Lizenz hinzuzufügen.

  Die folgenden Optionen werden nur angezeigt, wenn eine entsprechende API-URL verfügbar ist:

• Custom API: Öffnet den Konfigurationsbildschirm für benutzerdefinierte APIs, um manuell eine neue benutzerdefinierte API zu erstellen.

• Proxy API: Öffnet den Konfigurationsbildschirm für Proxy-APIs, um manuell eine neue Proxy-API zu erstellen.

• OData Service: Öffnet den Konfigurationsbildschirm für OData-Services, um manuell einen neuen OData-Service zu erstellen.

Listenansicht

Um die Listenansicht zu öffnen, wählen Sie das Symbol Listenansicht aus.

Die Listenansicht zeigt APIs in einer Tabelle an. Jede Spalte wird nachfolgend beschrieben. Klicken Sie auf eine API-Zeile, um die API-Details-Schublade zu öffnen.

Die verfügbaren Spalten sind folgende:

• API-Name: Der Name der API.

• Version: Die Version der API, wie während der API-Konfiguration eingegeben.

• Typ: Der Typ der API, einer der folgenden: Custom API, OData Service oder Proxy API.

• Umgebung: Die Umgebung, in der die API gespeichert ist.

• Status: Der Status der API, einer der folgenden: Veröffentlicht, Veröffentlicht mit Entwurf oder Entwurf.

• Zuletzt bearbeitet: Das letzte Speicherdatum (im Format MM/DD/YYYY), die Uhrzeit (im Format HH:MM:SS) und die Tageszeit (AM oder PM) in der lokalen Browserzeit.

• Service Root: Der öffentliche Name der API, wie während der API-Konfiguration eingegeben.

• Gruppe: Der Name aller API-Gruppen, denen die API angehört.

• Bearbeitet von: Der Name des Benutzers, der die API zuletzt gespeichert hat.

• Zuletzt veröffentlicht: Das Veröffentlichungsdatum (im Format MM/DD/YYYY), die Uhrzeit (im Format HH:MM:SS) und die Tageszeit (AM oder PM) in der lokalen Browserzeit.

• Veröffentlicht von: Der Name des Benutzers, der die API zuletzt veröffentlicht hat.

• Gateway: Das von der API verwendete API-Gateway.

• Services: Die Anzahl der für die API konfigurierten Services.

• Aktionen: Halten Sie den Mauszeiger über die API-Zeile, um zusätzliche Aktionen anzuzeigen:

  • Details: Öffnet die API-Details-Schublade (beschrieben im nächsten Abschnitt).

  • API-Basis-URL kopieren: Klicken Sie, um die Basis-URL der API in die Zwischenablage zu kopieren. Eine Bestätigungsmeldung wird angezeigt, wenn die Aktion abgeschlossen ist.

  • Exportieren: Öffnet den Ordnerauswahlknoten für Ihren lokalen Computer. Wählen Sie einen Ordner aus, um den API-Export zu speichern. Um verknüpfte Studio-Projekte einzubeziehen, verwenden Sie stattdessen API exportieren aus dem Seitenkopf. Weitere Informationen finden Sie unter APIs exportieren und importieren.

  • Herunterladen: Lädt die API-Details als CSV-Datei herunter. Klicken Sie, um das Dialogfeld API-Details herunterladen zu öffnen, in dem Sie zusätzliche Felder auswählen können, die einbezogen werden sollen, und diese mit neu anordnen können. Einige Felder sind vorausgewählt und können nicht entfernt werden. Klicken Sie auf Herunterladen, um die Datei zu speichern.

  • Bearbeiten: Öffnet die API-Details-Schublade, in der Sie die API-Einstellungen bearbeiten können.

  • Weitere Aktionen: Öffnet ein Menü mit folgenden Aktionen:

    API-Menüelement	Beschreibung
    Klonen	Öffnet den API-Konfigurationsbildschirm (siehe Konfiguration benutzerdefinierter APIs, Konfiguration von OData-Services oder Konfiguration von Proxy-APIs), mit den Konfigurationsdetails der geklonten API und aktualisierten Standardwerten für diese Felder vorausgefüllt: API-Name: Dem API-Namen wird Copy of vorangestellt. Service Root: Der Service Root wird Copyof vorangestellt. Version: Der Version wird -2 angehängt. Diese Nummer wird bei weiteren Klonen nicht erhöht.
    Löschen	Löscht die API dauerhaft. Wenn Sie auf Löschen klicken, wird ein Bestätigungsdialogfeld angezeigt, in dem Sie bestätigen können, dass Sie die API dauerhaft löschen möchten. Vorsicht Die OpenAPI-Dokumentation, die auf der Seite API Portal angezeigt wird, wird nicht automatisch aktualisiert, wenn Sie eine API löschen. Um die OpenAPI-Dokumentation zu aktualisieren, verwenden Sie die Seite Portal Manager oder die Registerkarte Dokumentation auf der Seite APIs.
    Im Portal anzeigen	(Nur aktiviert für benutzerdefinierte oder Proxy-APIs mit dem Status Veröffentlicht oder Veröffentlicht mit Entwurf.) Öffnet die Seite API Portal für die API.
    Protokolle anzeigen	Öffnet die Seite API-Protokolle, auf der Verarbeitungs- und Debug-Protokolle (falls Debug-Protokollierung aktiviert ist) für alle APIs angezeigt werden.
    Analysen	Öffnet die Seite Analysen, auf der Verbrauchs- und Leistungsmetriken für alle APIs angezeigt werden.

Einstellungen der Listenansicht

Sie können die Tabelle sortieren, ihre Spalten neu anordnen oder ihren Inhalt aktualisieren:

• Sortieren: Um die Tabelle in aufsteigender Reihenfolge zu sortieren, klicken Sie auf eine beliebige Spaltenüberschrift. Klicken Sie erneut, um die Sortierreihenfolge umzukehren.

• Spalten: Um die Anordnung und Sichtbarkeit von Spalten zu ändern, klicken Sie auf Spalten filtern. Die Schublade Spalten wird geöffnet:

  

  Die Schublade enthält die folgenden Steuerelemente:

  • Suche: Geben Sie einen beliebigen Teil des Spaltennamens in das Suchfeld ein, um die Liste der Spalten zu filtern. Verwenden Sie nur alphanumerische Zeichen. Bei der Suche wird nicht zwischen Groß- und Kleinschreibung unterschieden.

  • Alle anzeigen: Machen Sie alle Spalten sichtbar.

  • Verschieben: Ziehen Sie die Spalte per Drag-and-Drop, um ihre Position relativ zu anderen zu ändern.

  • Ausblenden: Die Spalte ist sichtbar. Klicken Sie, um sie auszublenden.

  • Anzeigen: Die Spalte ist ausgeblendet. Klicken Sie, um sie anzuzeigen.

  • Speichern: Speichern Sie die Spalten.

  • Abbrechen: Schließen Sie die Schublade ohne Speicherung der Änderungen.

Kartenansicht

Um auf die Kartenansicht zuzugreifen, wählen Sie das Symbol Kartenansicht aus.

In der Kartenansicht werden APIs als Karten in einem Raster angezeigt.

Jede Karte zeigt folgende Informationen:

• API-Name: Der Name der API. Bewegen Sie den Mauszeiger über die Karte und klicken Sie auf das Symbol Kopieren neben dem Namen, um die Service-URL der API in die Zwischenablage zu kopieren. Das Symbol gibt den API-Typ an:

  Symbol	API-Typ
  	Benutzerdefinierte API
  	OData-Service
  	Proxy-API

• Services: Die Anzahl der Services, die für die API konfiguriert sind.

• Version: Die Version der API, wie während der API-Konfiguration eingegeben.

• Umgebung: Der Umgebungsname und die Klasse, in der die API gespeichert ist.

• Statussymbol: Ein farbiges Symbol links neben der E-Mail-Adresse des letzten Bearbeiters zeigt den aktuellen Status der API an:

  Farbe	Status
  	Die API wird veröffentlicht.
  	Die API wird mit einem Entwurf veröffentlicht.
  	Die API ist ein Entwurf.

• Zuletzt bearbeitet von: Die E-Mail-Adresse des Benutzers, der die API zuletzt bearbeitet hat.

• Zuletzt bearbeitet am: Das Datum (im Format MM/TT/YY) und die Zeit (im Format HH:MM AM/PM) der letzten Bearbeitung der API in der lokalen Browserzeit.

Klicken Sie auf eine Karte, um die Schublade mit API-Details zu öffnen. Klicken Sie auf das Menüsymbol Aktionen in der oberen rechten Ecke einer Karte, um ein Menü mit diesen Aktionen zu öffnen:

API-Details-Drawer

Sie können den API-Details-Drawer aus der Listenansicht öffnen, indem Sie eine API in der Tabelle auswählen oder auf Bearbeiten klicken, oder aus der Kartenansicht, indem Sie auf eine Karte klicken. Ein Drawer wird am unteren Ende des Fensters mit diesen Reitern geöffnet, je nach API-Typ:

Der Header des Drawers zeigt diese Details und Steuerelemente:

• API-Name und Version: Zeigt den Namen der API und ihre Version, falls zutreffend.

• Vorherige / Nächste: Navigiert durch die Liste der APIs der Organisation.

• Erweitern: Erweitert den Drawer auf Vollbildschirm. Nach der Erweiterung klicken Sie auf das Symbol Minimieren, um zur vorherigen Ansicht zurückzukehren.

• Schließen: Schließt den Drawer.

• Änderungen verwerfen: Nach dem Vornehmen von Änderungen klicken Sie hier, um den Drawer zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

• Als Entwurf speichern: Speichert alle Änderungen an der API im Status Entwurf oder Veröffentlicht mit Entwurf:

  • Entwurf: Eine neue API oder eine API, deren Status Entwurf war, als Als Entwurf speichern verwendet wurde. Entwürfe werden nicht auf Ihr Abonnementlimit angerechnet.

  • Veröffentlicht mit Entwurf: Eine API, deren Status Veröffentlicht war, als Als Entwurf speichern verwendet wurde. Eine veröffentlichte API mit einem Entwurf wird auf Ihr Abonnementlimit angerechnet, da die API zugänglich ist, obwohl ihr Entwurf nicht zugänglich ist.

• Veröffentlichen: Speichert Änderungen an der API im Status Veröffentlicht. Die API ist live und innerhalb von fünf Minuten zugänglich. Eine veröffentlichte API wird auf Ihr Abonnementlimit angerechnet, da die API zugänglich ist. Ein Dialog gibt an, dass die API live ist. Klicken Sie auf URL kopieren, um die API-Service-URL zu kopieren.

Reiter „Profil"

Der Reiter Profil zeigt allgemeine Informationen über die API:

• API-Typ: Der Typ der API, einer der folgenden: Benutzerdefinierte API, OData-Dienst oder Proxy-API.

• Basis-API-URL: Die Basis-URL der API.

• API-Name: Der Name der API für interne Identifikationszwecke. Die folgenden Sonderzeichen sind zulässig: ( ) - _

• Service Root: Der öffentliche Name der API, der als Teil der API-Service-URL verwendet wird. Standardmäßig ist dieses Feld mit dem API-Namen gefüllt, der in Camel Case konvertiert ist. Dieses Feld erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von Sonderzeichen außer einem Unterstrich (_) wird nicht empfohlen. Die folgenden Sonderzeichen sind zulässig:

  . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

• Beschreibung: (Nur für benutzerdefinierte APIs und OData-Dienste sichtbar.) Die Beschreibung der API.

• Umgebung: Die Umgebung, in der sich die API befindet. Dieses Feld kann nicht bearbeitet werden.

• Versionsnummer: Die Version, die als Teil der API-Service-URL verwendet wird. Dieses Feld erlaubt maximal 48 Zeichen und keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von Sonderzeichen außer einem Punkt (.) oder einem Bindestrich (-) wird nicht empfohlen. Häufige Namenskonventionen sind inkrementelle Versionen wie v1.0, v1.1, v1.2 oder die Verwendung eines Datums, an dem die API veröffentlicht wurde, wie 2025-08-28.

Registerkarte "Settings"

In der Registerkarte Settings können Sie die Einstellungen einer API anzeigen oder bearbeiten:

• Timeout: Die Anzahl der Sekunden, bevor die API eine Zeitüberschreitung aufweist. Der Standardwert ist 30 Sekunden. Das Maximum beträgt 180 Sekunden.

  Hinweis

  Diese Einstellung ist unabhängig von der Timeout-Einstellung für Vorgänge in Studio oder Design Studio. Die Timeout-Einstellungen für Vorgänge werden nur verwendet, wenn ein Private Agent verwendet wird und die Einstellung EnableAPITimeout in der Konfigurationsdatei des Private Agents aktiviert ist.

• SSL only: Wenn aktiviert (Standard), werden Daten per SSL verschlüsselt und HTTPS wird für alle API-Anfragen und -Antworten erzwungen (empfohlen).

  Wenn deaktiviert, werden Daten, die durch API-Anfragen und -Antworten übertragen werden, nicht verschlüsselt und können von anderen abgefangen und angezeigt werden. Dies könnte möglicherweise sensible Informationen offenlegen.

• CORS: Wenn aktiviert, wird der Mechanismus Cross-Origin Resource Sharing (CORS) verwendet (nicht empfohlen).

  Warnung

  CORS führt dazu, dass Vorgänge mit der Methode OPTIONS ohne Authentifizierung ausgeführt werden.

• Verbose logging: Wenn aktiviert, wird bei ausführlichem Logging für APIs die Anfrage- und Antwortdaten in jedem API-Protokoll eingebunden, um die Überwachung ein- und ausgehender Daten und die Fehlerbehebung zu erleichtern. Diese Einstellung ist standardmäßig deaktiviert, da sie große Protokolldateien erstellen kann.

• Enable debug mode until: Zeigt das Datum und die Uhrzeit an, zu der der Debug-Modus deaktiviert wird.

Registerkarte "Existing API"

In der Registerkarte Existing API können Sie die Basis-URL einer Proxy-API anzeigen und bearbeiten:

• Base API URL: Die Basis-URL der API, für die ein Proxy erstellt werden soll.

  Hinweis

  Wenn die API einen einzelnen Dienst bietet, können Sie die vollständige API-URL einschließlich des Dienstpfads eingeben.

• Provide OpenAPI document: Wenn ein OpenAPI-Dokument bereitgestellt wird, wird es zur automatischen Ermittlung der API-Dienste verwendet. Wählen Sie No zum Überspringen oder Yes zum Erweitern eines zusätzlichen Bereichs zur Bereitstellung des OpenAPI-Dokuments:

  

  • OpenAPI URL: Wenn ausgewählt, wird ein Feld OpenAPI URL verfügbar, in das Sie eine URL eingeben können. Klicken Sie auf Apply, um ein OpenAPI-Dokument im YAML- oder JSON-Format von der URL zu laden.

  • Upload File: Wenn ausgewählt, lädt ein OpenAPI-Dokument im YAML- oder JSON-Format nach der Verwendung von Browse zum Auswählen der Datei hoch:

    

  • Document editor: Ermöglicht die Anzeige und Bearbeitung eines bereitgestellten OpenAPI-Dokuments. Sie können auch ein OpenAPI-Dokument bereitstellen, indem Sie es hier direkt eingeben. Um das OpenAPI-Dokument in einem größeren Bereich anzuzeigen und zu bearbeiten, klicken Sie auf das Symbol "Expand" (klicken Sie nach dem Öffnen dieses Bereichs auf das Symbol "Collapse" , um zu diesem Bildschirm zurückzukehren).

Registerkarte "Services"

In der Registerkarte Services können Sie neue Dienste hinzufügen oder aktuelle API-Dienste anzeigen und bearbeiten. Klicken Sie auf einen API-Dienst, um ihn zu bearbeiten.

Die Tabelle kann nach Service Name, Method, Path, Project, Operation To Trigger oder Response Type sortiert werden, indem auf die jeweilige Kopfzeile geklickt wird.

• Search: Geben Sie einen beliebigen Teil des Dienstnamens, der Methode, des Pfads, des Projekts, des Vorgangs oder des Antworttyps in das Suchfeld ein, um die Liste der Dienste zu filtern. Verwenden Sie nur alphanumerische Zeichen. Bei der Suche wird die Groß-/Kleinschreibung nicht berücksichtigt.

• New Service: Fügt eine API-Dienst-Zeile unten in der Tabelle hinzu. Geben Sie Werte für jedes Feld in der Tabelle ein oder wählen Sie diese aus (siehe unten).

• Service Name: Der Name des API-Services.

• Method: Die Request-Methode für den API-Service, einer von GET, POST, PUT, DELETE, ALL oder (wenn die Method auf CUSTOM eingestellt ist) der Name der benutzerdefinierten Methode.

• Path: Der Pfad für den Request.

• Project: (Nur für benutzerdefinierte APIs und OData-Services sichtbar.) Der Name des Studio-Projekts.

• Operation To Trigger: (Nur für benutzerdefinierte APIs und OData-Services sichtbar.) Der Name der aufgerufenen Operation.

• Response Type: (Nur für benutzerdefinierte APIs und OData-Services sichtbar.) Der Response-Typ, einer von Final Target, System Variable oder No Response.

• Actions: Fahren Sie über die Service-Zeile, um zusätzliche Aktionen anzuzeigen:

  • Copy API service URL: Klicken Sie, um die API-Service-URL in die Zwischenablage zu kopieren. (Eine Bestätigung der Aktion wird angezeigt.)

  • Go to operation: Öffnet das Studio-Projekt in einem neuen Browser-Tab. Die Operation im Feld Operation To Trigger wird auf dem Designbereich von Studio hervorgehoben. Diese Aktion ist für Design Studio-Operationen deaktiviert.

  • Duplicate: (Nur für benutzerdefinierte APIs und OData-Services sichtbar.) Erstellt ein Duplikat des API-Services. Sie müssen entweder die Request-Methode oder den Path ändern, da jeder API-Service eine eindeutige Kombination dieser Felder haben muss.

  • Delete: Löscht den API-Service.

  Wenn Sie auf eine benutzerdefinierte API- oder Proxy-API-Service-Zeile klicken, werden diese Tabs angezeigt:

  

  Path params tab

  Wenn Request-Parameter im Path enthalten sind, wird dieser Tab mit diesen Feldern ausgefüllt:

  

  • Parameter: Zeigt die im Path definierten Request-Parameter an.

  • Description: Geben Sie optional eine Beschreibung für die Request-Parameter ein.

  Query params tab

  Dieser Tab ermöglicht es Ihnen, Abfrageparameter zum API-Service hinzuzufügen:

  

  • Add Parameter: Klicken Sie, um einen Abfrageparameter zum API-Service hinzuzufügen. Wenn angeklickt, werden diese Felder verfügbar:

    • Parameter: Geben Sie den Namen des Abfrageparameters ein.

    • Description: Geben Sie optional die Beschreibung des Abfrageparameters ein.

    • Delete: Klicken Sie auf das Lösch-Symbol neben einem Abfrageparameter, um diesen Parameter zu löschen.

  Headers tab

  Dieser Tab ermöglicht es Ihnen, Request-Header zum API-Service hinzuzufügen:

  

  • Add Parameter: Klicken Sie, um einen Request-Header zum API-Service hinzuzufügen. Wenn angeklickt, werden diese Felder verfügbar:

    • Parameter: Geben Sie den Namen des Request-Headers ein.

    • Description: Geben Sie optional die Beschreibung des Request-Headers ein.

    • Required: Wählen Sie aus, ob der Request-Header für jeden API-Service-Request erforderlich sein soll.

    • Delete: Löscht den Request-Header.

  Bei Proxy-APIs sind die Beschreibungen von Pfad-Parametern schreibgeschützt, Abfrageparameter haben auch einen Required-Schalter, und Services mit mehr als einer Methode haben einen Tab für jede Methode. Weitere Details finden Sie unter Service parameters in der Proxy-API-Konfiguration.

Security profiles tab

Der Tab Security profiles enthält eine Liste der Sicherheitsprofile, die in der Umgebung verfügbar sind:

Sie können die Tabelle nach Profile Name, Type oder User Name sortieren, indem Sie auf die entsprechende Kopfzeile klicken.

• Search: Geben Sie einen beliebigen Teil des Sicherheitsprofilnamens, des Typs oder des Benutzernamens in das Suchfeld ein, um die Liste der Services zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche ist nicht case-sensitiv.

• Zuweisen: Verwenden Sie den Schalter, um das Sicherheitsprofil der API zuzuweisen oder zuzuweisungen zu entfernen.

  Zuweisungsregeln für Sicherheitsprofile

  • Mehrere Profile: Sie können mehrere Sicherheitsprofile mit demselben Authentifizierungstyp einer API zuweisen. Nur die Authentifizierungstypen basic und API key können zusammen verwendet werden.

  • Veröffentlichungsänderungen: Wenn Sie ein Sicherheitsprofil mit dem Schalter von einer API entfernen, wird die Änderung als Entwurf gespeichert. Sie müssen die API veröffentlichen (verwenden Sie Publish in der Kopfleiste des Fensters), damit die Änderung wirksam wird. Bis die API veröffentlicht wird, wird das Sicherheitsprofil weiterhin als „in Verwendung" betrachtet und kann nicht von der Seite Sicherheitsprofile gelöscht werden.

• Profilname: Der Name des Sicherheitsprofils.

• Typ: Der Authentifizierungstyp, einer von Anonymous, API key, Basic oder OAuth 2.0.

• Benutzername: Zeigt den Benutzernamen für alle Sicherheitsprofile an, die die Basic-Authentifizierung verwenden. Andernfalls wird der Authentifizierungstyp angezeigt.

• Aktionen: Bewegen Sie den Mauszeiger über die Zeile des Sicherheitsprofils, um eine zusätzliche Aktion anzuzeigen:

  • Zum Sicherheitsprofil wechseln: Öffnet den Konfigurationsbildschirm für das Sicherheitsprofil.

Registerkarte „Benutzerrollen"

Die Registerkarte Benutzerrollen enthält eine Liste der Organisationsrollen, deren Mitglieder Zugriff auf die API haben:

Sie können die Tabelle nach Benutzerrolle sortieren, indem Sie auf die entsprechende Kopfzeile klicken.

• Suchen: Geben Sie einen beliebigen Teil der Benutzerrolle, Berechtigung oder des Status in das Suchfeld ein, um die Liste der Services zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche beachtet keine Groß- und Kleinschreibung.

• Neue Benutzerrolle: Öffnet ein Fenster zum Konfigurieren einer neuen Benutzerrolle:

  

  • Rollenname: Geben Sie einen eindeutigen Namen für die Rolle ein.
  • Berechtigungen: Klicken Sie, um das Menü zu öffnen, und wählen Sie mindestens eine Berechtigung aus der Liste.

  • Status: Zeigt an, ob die Benutzerrolle der API zugewiesen ist oder nicht.

    Regeln für die Rollenverwaltung

    Diese Regeln gelten für die Verwaltung von Rollen in APIs:

    • Benutzer mit der Berechtigung Admin oder dem Write-Zugriff auf Umgebungen können Rollen APIs zuweisen oder Zuweisungen entfernen.
    • Benutzer mit der Berechtigung Admin können neue Rollen erstellen und zuweisen.
    • Benutzer mit der Berechtigung Admin können von keinem Benutzer von einer API entfernt werden.

  • Speichern: Speichert die Rolle und fügt sie der Tabelle der Rollen hinzu.

  • Abbrechen: Schließt das Fenster, ohne Änderungen zu speichern.

• Benutzerrolle: Der Name der Harmony-Benutzerrolle.

• Aktionen: Bewegen Sie den Mauszeiger über die Zeile der Benutzerrolle, um eine zusätzliche Aktion anzuzeigen:

  • Zur Benutzerrolle wechseln: Öffnet die Seite Benutzerverwaltung der Management Console.

Registerkarte „Anfrage-Header"

Die Registerkarte Anfrage-Header enthält eine Liste der Anfrage-Header einer Proxy-API:

Sie können die Tabelle nach Schlüssel oder Wert sortieren, indem Sie auf die entsprechende Kopfzeile klicken.

• Schlüssel: Der Schlüssel des Anfrage-Headers.

• Wert: Der Wert des Anfrage-Headers.

• Eingehende überschreiben: Wenn diese Option aktiviert ist, überschreibt der Anfrage-Header andere Anfrage-Header, die denselben Schlüssel verwenden.

  Note

  Um diese Einstellung zu ändern, müssen Sie in der Tabelle auf Edit in der Spalte Action der API klicken.

• Aktionen: Bewegen Sie den Mauszeiger über die Zeile des Anfrage-Headers, um eine zusätzliche Aktion anzuzeigen:

• Header löschen: Löscht die Anfrage-Header-Zeile.

Registerkarte „Dokumentation"

Die Registerkarte Dokumentation ist verfügbar, wenn eine veröffentlichte API bearbeitet wird, und ermöglicht es, die OpenAPI-Dokumentation für diese einzelne API anzuzeigen, zu bearbeiten und zu veröffentlichen. Diese Registerkarte ist für veröffentlichte benutzerdefinierte Services, Proxy-Services und OData-Services verfügbar.

• Docs neu generieren: Klicken Sie hier, um die OpenAPI-Dokumentation nur für diese API neu zu generieren und zu überschreiben. Diese Option ist nur für bereits veröffentlichte APIs verfügbar.

  Warnung

  Mit dieser Option wird die vorhandene Dokumentation für diese API überschrieben, einschließlich aller Anpassungen. Sichern Sie die vorhandene Dokumentation, indem Sie diese vor Verwendung dieser Option in einen externen Text-Editor kopieren. Nach der Neugenerierung der Dokumentation wenden Sie alle Anpassungen manuell erneut an, indem Sie diese im Editor entsprechend einfügen.

  Um die Dokumentation neu zu generieren, ohne Anpassungen zu überschreiben, verwenden Sie stattdessen Docs neu generieren auf der Seite Portal Manager. Wenn Sie die Dokumentation für alle benutzerdefinierten und Proxy-APIs in einer Umgebung gleichzeitig neu generieren, behält diese Option Anpassungen bei und wendet diese automatisch erneut an, sodass Sie Konflikte beheben können. Diese Alternative ist für OData-Services nicht verfügbar.

• Speichern & Veröffentlichen: Klicken Sie hier, um Dokumentationsänderungen nur für diese API zu speichern und auf der Seite API Portal zu veröffentlichen.

• Editor: Bearbeiten Sie den YAML-Dokumentationsinhalt für diese API direkt im Editor. Änderungen werden in der Swagger-Vorschau auf der rechten Seite der Registerkarte angezeigt.

  Klicken Sie nach den Bearbeitungen auf Speichern & Veröffentlichen, um die aktualisierte Dokumentation auf der Seite API Portal zu veröffentlichen.

• Swagger-Vorschau: Zeigt die interaktive Swagger UI-Dokumentation für die API an. Sie können die Vorschau verwenden, um die API direkt von der Registerkarte Dokumentation aus zu testen, indem Sie die unter APIs testen auf der Seite Portal Manager beschriebenen Kontrollen verwenden.

Fehlerbehebung

Weitere Informationen zur Fehlerbehebung finden Sie in folgendem Abschnitt des Handbuchs zur Fehlerbehebung im API Manager:

• API kann nicht veröffentlicht werden: Limit für Abonnement-APIs erreicht

• Veröffentlichte API gibt 404 Not Found zurück

• API-Umgebung kann nach der Erstellung nicht geändert werden

• Schaltfläche „Neue API" trotz korrekter Organisationsrolle nicht sichtbar

• Service-URL überschreitet maximale Länge (HTTP 414)

• API im API Manager kann nicht gelöscht werden