APIs-Seite im Jitterbit API Manager

Einführung

Die APIs-Seite ist die Hauptseite des API Managers. Sie ermöglicht es den Administratoren der Harmony-Organisation, drei Arten von APIs zu verwalten:

• Benutzerdefinierte APIs
• OData-APIs
• Proxy-APIs

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

Mitglieder einer Rolle, die Lese- Umgebungszugriff gewährt bekommen hat, können nur die APIs in dieser Umgebung anzeigen. Mitglieder einer Rolle, die Schreib- Umgebungszugriff gewährt bekommen hat, haben Schreibzugriff in dieser Umgebung.

Um auf die APIs-Seite zuzugreifen, verwenden Sie das Harmony-Portal-Menü, um API Manager > APIs auszuwählen.

Kopfzeile der APIs-Seite

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

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

• Verwendete benutzerdefinierte API-URLs: Die Anzahl der derzeit verwendeten benutzerdefinierten API-URLs aus der insgesamt erlaubten Anzahl von benutzerdefinierten API-URLs gemäß dem Abonnement der Organisation. Derzeit verwendete API-URLs umfassen die von veröffentlichten benutzerdefinierten APIs und OData-APIs sowie deren veröffentlichte Klone. Entwurf-APIs zählen nicht als verwendete API-URLs.

• Proxy-API-URLs verwendet: Die Anzahl der derzeit verwendeten Proxy-API-URLs aus der Gesamtzahl der durch das Abonnement der Organisation erlaubten Proxy-API-URLs. Derzeit verwendete Proxy-API-URLs umfassen die von veröffentlichten Proxy-APIs und deren veröffentlichten Klonen. Entwurf-APIs zählen nicht als verwendete API-URLs.

• Filter: Öffnet ein Fenster mit Steuerelementen, um die Tabelle nach API-Typ, API-Status, API-Gruppe, Umgebung, Sicherheitsprofil, Benutzerrolle, Zuletzt bearbeitet und Zuletzt veröffentlicht Daten zu filtern:

  

  Filter werden sofort angewendet. Verwenden Sie die Schaltflächen Löschen oder Alle löschen, um die Filter zurückzusetzen, und die Schließen-Schaltfläche, um das Fenster zu schließen. Wenn das Fenster geschlossen ist und Filter aktiv sind, zeigt ein numerisches Badge auf dem 7 Filter-Symbol die Gesamtzahl der angewendeten Filter an.

• Suche: Geben Sie einen Teil des API-Namens, der Version, der Umgebung, des Typs, der Beschreibung, des Status oder des Datums oder der Uhrzeit, zu der die API zuletzt veröffentlicht oder bearbeitet wurde, in das Suchfeld ein, um die Liste der APIs zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

• Ansicht: Klicken Sie auf das Listenansicht oder Kartenansicht Symbol, um das Format zu wechseln, das zur Anzeige von APIs auf dieser Seite verwendet wird. Das nächste Mal, wenn Sie die APIs-Seite laden, wird die zuletzt ausgewählte Ansicht vorausgewählt.

• Alle 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. Klicken Sie, um den Dialog API-Details herunterladen zu öffnen, in dem Sie zusätzliche Felder auswählen können, die einbezogen werden sollen, und verwenden, um sie neu anzuordnen. Einige Felder sind vorausgewählt und können nicht entfernt werden. Klicken Sie auf Herunterladen, um die Datei zu speichern.

• API importieren: Öffnet den API-Importbildschirm, auf dem Sie APIs im APK-Format importieren können (siehe Exportieren und Importieren von APIs).

• API exportieren: Öffnet den Bildschirm für den API-Export, auf dem Sie ausgewählte APIs im APK-Format exportieren können (siehe Exportieren und Importieren von APIs).

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

  • Mit KI erstellen: Öffnet den APIM-Assistenten, um eine API mit natürlichen Sprachaufforderungen zu erstellen. Weitere Informationen finden Sie unter Verwendung des KI-Assistenten.

    Hinweis

    Um den APIM KI-Assistenten zu verwenden, muss Ihre Harmony-Lizenz die Option APIM KI-Assistent enthalten. Kontaktieren Sie Ihren Customer Success Manager (CSM), um diese Option zu Ihrer Lizenz hinzuzufügen.

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

  • Benutzerdefinierte API: Öffnet den Bildschirm zur Konfiguration benutzerdefinierter APIs, um manuell eine neue benutzerdefinierte API zu erstellen.

  • Proxy-API: Öffnet den Bildschirm zur Konfiguration der Proxy-API, um manuell eine neue Proxy-API zu erstellen.

  • OData-API: Öffnet den Bildschirm zur Konfiguration der OData-API, um manuell eine neue OData-API zu erstellen.

Listenansicht

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

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

Die verfügbaren Spalten sind wie folgt:

• API-Name: Der Name der API.

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

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

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

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

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

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

• Gruppe: Der Name der API-Gruppen, zu denen die API gehört.

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

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

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

• Gateway: Das API-Gateway, das von der API verwendet wird.

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

• Aktionen: Fahren Sie mit der Maus über die API-Zeile, um zusätzliche Aktionen anzuzeigen:

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

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

  • Exportieren: Öffnet den Ordnerauswähler für Ihren lokalen Computer. Wählen Sie einen Ordner aus, um den API-Export zu speichern. Weitere Informationen finden Sie unter APIs exportieren und importieren.

  • Herunterladen: Lädt die API-Details als CSV-Datei herunter. Klicken Sie, um den Dialog API-Details herunterladen zu öffnen, in dem Sie zusätzliche Felder auswählen und verwenden können, um sie neu anzuordnen. Einige Felder sind vorausgewählt und können nicht entfernt werden. Klicken Sie auf Herunterladen, um die Datei zu speichern.

  • Bearbeiten: Öffnet die Seite Zusammenfassung & Bestätigung für die API, auf der Sie die Einstellungen der API bearbeiten können.

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

    API-Menüpunkt	Beschreibung
    Klonen	Öffnet den Bildschirm zur API-Konfiguration (siehe Benutzerdefinierte API-Konfiguration, OData API-Konfiguration oder Proxy-API-Konfiguration), vorab ausgefüllt mit den Konfigurationsdetails der geklonten API und aktualisierten Standardwerten für diese Felder: API-Name: Der API-Name wird mit Kopie von vorangestellt. Service-Root: Der Service-Root wird mit Kopie von vorangestellt. Version: Die Version wird mit -2 angehängt. Diese Nummer erhöht sich nicht bei zusätzlichen Klonen.
    Löschen	Löscht die API dauerhaft. Beim Klicken auf Löschen wird ein Bestätigungsdialog angezeigt, um zu bestätigen, 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 API-Seite.
    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, die Verarbeitungs- und Debug-Protokolle (wenn das Debug-Protokoll aktiviert ist) für alle APIs anzeigt.
    Analytik	Öffnet die Seite Analytik, die Verbrauchs- und Leistungskennzahlen für alle APIs anzeigt.

Listeneinstellungen der Seite

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 der Spalten zu ändern, klicken Sie auf Spalten filtern. Die Spalten-Schublade öffnet sich:

  

  Die Schublade enthält die folgenden Steuerungen:

  • Suchen: Geben Sie einen Teil des Spaltennamens in das Suchfeld ein, um die Liste der Spalten zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

  • Alle anzeigen: Alle Spalten sichtbar machen.

  • Verschieben: Ziehen und Ablegen, um die Position der Spalte im Verhältnis 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: Die Spalten speichern.

  • Abbrechen: Die Schublade schließen, ohne Änderungen zu speichern.

Kartenansicht

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

Die Kartenansicht zeigt APIs als Karten in einem Raster an.

Jede Karte zeigt die folgenden Informationen an:

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

  Symbol	API-Typ
  	Benutzerdefinierte API
  	OData API
  	Proxy API

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

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

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

• Statussymbol: Ein farbiges Symbol links von der Email des zuletzt bearbeitenden Benutzers zeigt den aktuellen Status der API an:

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

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

• Zuletzt bearbeitet am: Das Datum (im Format MM/DD/YY) und die Uhrzeit (im Format HH:MM AM/PM), wann die API zuletzt bearbeitet wurde, in lokaler Browserzeit.

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

API-Details-Bereich

Sie können den API-Details-Bereich 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 Bereich öffnet sich am unteren Rand des Fensters mit diesen Tabs, abhängig vom API-Typ:

Die Kopfzeile des Bereichs zeigt diese Details und Steuerungen an:

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

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

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

• Schließen: Schließt den Bereich.

• Änderungen verwerfen: Nach Änderungen klicken Sie, um den Bereich zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob 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 zählen nicht gegen Ihr Abonnementlimit.

• Veröffentlicht mit Entwurf: Eine API, deren Status Veröffentlicht war, als Als Entwurf speichern verwendet wurde. Eine API, die mit einem Entwurf veröffentlicht wird, zählt gegen Ihr Abonnementlimit, da die API zugänglich ist, auch wenn ihr Entwurf nicht.

• 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 zählt gegen Ihr Abonnementlimit, da die API zugänglich ist. Ein Dialog zeigt an, dass die API live ist. Klicken Sie auf URL kopieren, um die API-Dienst-URL zu kopieren.

Profil-Tab

Der Profil-Tab zeigt allgemeine Informationen über die API an:

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

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

• API-Name: Der Name der API zur internen Identifikation. Die folgenden Sonderzeichen sind erlaubt: ( ) - _

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

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

• Beschreibung: (Sichtbar nur für benutzerdefinierte APIs und OData APIs.) 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 Dienst-URL der API verwendet wird. Dieses Feld erlaubt maximal 48 Zeichen und erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von Sonderzeichen außer einem Punkt (.) oder einem Bindestrich (-) wird nicht empfohlen. Häufige Namenskonventionen umfassen die Erhöhung von Versionen, wie v1.0, v1.1, v1.2, oder die Verwendung eines Datums, an dem die API veröffentlicht wurde, wie 2025-08-28.

Einstellungen-Tab

Im Einstellungen-Tab können Sie die Einstellungen einer API anzeigen oder bearbeiten:

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

  Hinweis

  Diese Einstellung ist unabhängig von der Timeout-Einstellung der Operation in Studio oder Design Studio. Timeout-Einstellungen für Operationen werden nicht verwendet, es sei denn, ein privater Agent wird verwendet und die Einstellung EnableAPITimeout in der Konfigurationsdatei des privaten Agents ist aktiviert.

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

  Wenn deaktiviert, sind die über API-Anfragen und -Antworten übermittelten Daten nicht verschlüsselt und können von anderen abgefangen und eingesehen werden. Dies könnte potenziell sensible Informationen offenlegen.

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

  Warnung

  CORS führt dazu, dass Operationen, die die OPTIONS-Methode verwenden, ohne Authentifizierung ausgeführt werden.

• Ausführliches Protokollieren: Wenn aktiviert, umfasst das ausführliche Protokollieren für APIs Anforderungs- und Antwortdaten in jedem API-Protokoll, um eingehende und ausgehende Daten zu überwachen und das Debuggen zu erleichtern. Diese Einstellung ist standardmäßig deaktiviert, da sie große Protokolldateien erzeugen kann.

• Debug-Modus aktivieren bis: Zeigt das Datum und die Uhrzeit an, wann der Debug-Modus deaktiviert wird.

Vorhandene API-Tab

Im Vorhandene API-Tab können Sie die Basis-URL einer Proxy-API anzeigen und bearbeiten:

• Basis-API-URL: Die Basis-URL der API, die proxyisiert werden soll.

  Hinweis

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

• OpenAPI-Dokument bereitstellen: Wenn ein OpenAPI-Dokument bereitgestellt wird, wird es verwendet, um die Dienste der API automatisch zu entdecken. Wählen Sie Nein, um zu überspringen, oder Ja, um einen zusätzlichen Bereich zum Bereitstellen des OpenAPI-Dokuments zu erweitern:

  

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

  • Datei hochladen: Wenn ausgewählt, wird ein OpenAPI-Dokument im YAML- oder JSON-Format hochgeladen, nachdem Sie Durchsuchen verwendet haben, um die Datei auszuwählen:

    

  • Dokumenteneditor: Ermöglicht das Anzeigen und Bearbeiten 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 Popout-Symbol (nachdem Sie diesen Bereich geöffnet haben, klicken Sie auf das Rückkehrsymbol , um zu diesem Bildschirm zurückzukehren).

Dienste-Tab

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

Sie können die Tabelle nach Dienstname, Methode, Pfad, Projekt, Auszulösende Operation oder Antworttyp sortieren, indem Sie auf die jeweilige Kopfzeile klicken.

• Suche: Geben Sie einen Teil des Dienstnamens, der Methode, des Pfads, des Projekts, der Operation oder des Antworttyps in das Suchfeld ein, um die Liste der Dienste zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

• Neuer Dienst: Fügt eine API-Dienstzeile am Ende der Tabelle hinzu. Geben Sie Werte für jedes Feld in der Tabelle ein oder wählen Sie sie aus (siehe unten).

• Service Name: Der Name des API-Dienstes.

• Method: Die Anforderungsmethode für den API-Dienst, eine der GET, POST, PUT, DELETE, ALL oder (wenn die Method auf CUSTOM gesetzt ist) der Name der benutzerdefinierten Methode.

• Path: Der Pfad für die Anfrage.

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

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

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

• Actions: Fahren Sie mit der Maus über die Dienstzeile, um zusätzliche Aktionen anzuzeigen:

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

  • Go to API Service: Öffnet die Seite Zusammenfassung & Bestätigung für die API, auf der Sie die Einstellungen der API bearbeiten können.

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

  • Delete: Löscht den API-Dienst.

  Wenn Sie auf eine Zeile eines benutzerdefinierten API-Dienstes klicken, erscheinen diese Registerkarten:

  

  Path params tab

  Wenn Anforderungsparameter im Path enthalten sind, wird diese Registerkarte mit diesen Feldern gefüllt:

  

  • Parameter: Zeigt die im Path definierten Anforderungsparameter an.

  • Description: Geben Sie optional eine Beschreibung für die Anforderungsparameter ein.

  Query params tab

  Diese Registerkarte ermöglicht es Ihnen, Abfrageparameter zum API-Dienst hinzuzufügen:

  

  • Parameter hinzufügen: Klicken Sie, um einen Abfrageparameter zum API-Dienst hinzuzufügen. Nach dem Klicken werden diese Felder verfügbar:

    • Parameter: Geben Sie den Namen des Abfrageparameters ein.

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

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

  Registerkarte Header

  Diese Registerkarte ermöglicht es Ihnen, Anforderungsheader zum API-Dienst hinzuzufügen:

  

  • Parameter hinzufügen: Klicken Sie, um einen Anforderungsheader zum API-Dienst hinzuzufügen. Nach dem Klicken werden diese Felder verfügbar:

    • Parameter: Geben Sie den Namen des Anforderungsheaders ein.

    • Beschreibung: Geben Sie optional die Beschreibung des Anforderungsheaders ein.

    • Erforderlich: Wählen Sie aus, ob der Anforderungsheader für jede API-Dienstanforderung erforderlich sein soll.

    • Löschen: Löscht den Anforderungsheader.

Registerkarte Sicherheitsprofile

Die Sicherheitsprofile-Registerkarte bietet eine Liste von Sicherheitsprofilen, die in der Umgebung verfügbar sind:

Sie können die Tabelle nach Profilname, Typ oder Benutzername sortieren, indem Sie auf die jeweilige Kopfzeile klicken.

• Suchen: Geben Sie einen Teil des Namens des Sicherheitsprofils, des Typs oder des Benutzernamens in das Suchfeld ein, um die Liste der Dienste zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

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

  Regeln zur Zuweisung von Sicherheitsprofilen

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

  • Änderungen veröffentlichen: Wenn Sie ein Sicherheitsprofil von einer API mit dem Schalter abziehen, wird die Änderung als Entwurf gespeichert. Sie müssen die API veröffentlichen (indem Sie Veröffentlichen im Drawer-Header verwenden), damit die Änderung wirksam wird. Bis die API veröffentlicht ist, 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 Anonym, API-Schlüssel, Basis oder OAuth 2.0.

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

• Aktionen: Fahren Sie mit der Maus über die Zeile des Sicherheitsprofils, um eine zusätzliche Aktion anzuzeigen:

  • Gehe zu Sicherheitsprofil: Öffnet den Konfigurationsbildschirm für das Sicherheitsprofil.

Benutzerrollen-Tab

Der Benutzerrollen-Tab bietet 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.

• Suche: Geben Sie einen Teil der Benutzerrolle, Berechtigung oder des Status in das Suchfeld ein, um die Liste der Dienste zu filtern. Verwenden Sie nur alphanumerische Zeichen. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

• Neue Benutzerrolle: Öffnet ein Fenster, um eine neue Benutzerrolle zu konfigurieren:

  

  • Rollename: 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 aus.

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

    Regeln zur Rollenverwaltung

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

    • Benutzer mit Admin Berechtigung oder Schreib- Umgebungszugriff können Rollen für APIs zuweisen oder entfernen.
    • Benutzer mit Admin Berechtigung können neue Rollen erstellen und zuweisen.
    • Benutzer mit Admin Berechtigung können von keinem Benutzer von einer API abgemeldet werden.

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

  • Abbrechen: Schließt die Seitenleiste, ohne Änderungen zu speichern.

• Benutzerrolle: Der Name der Harmony-Benutzerrolle.

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

  • Zur Benutzerrolle gehen: Öffnet die Seite Benutzerverwaltung der Management-Konsole.

Registerkarte "Anforderungsheader"

Die Registerkarte Anforderungsheader bietet eine Liste der Anforderungsheader einer Proxy-API:

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

• Schlüssel: Der Schlüssel des Anforderungsheaders.

• Wert: Der Wert des Anforderungsheaders.

• Eingehende Überschreiben: Wenn aktiviert, überschreibt der Anforderungsheader andere Anforderungsheader, die denselben Schlüssel verwenden.

  Hinweis

  Um diese Einstellung zu bearbeiten, müssen Sie auf Bearbeiten in der Aktion-Spalte der API in der Tabelle klicken.

• Aktionen: Bewege den Mauszeiger über die Zeile des Anforderungsheaders, um eine zusätzliche Aktion anzuzeigen:

  • Header löschen: Löscht die Zeile des Anforderungsheaders.

Registerkarte "Dokumentation"

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

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

  Warnung

  Die Verwendung dieser Option überschreibt die vorhandene Dokumentation für diese API, einschließlich aller Anpassungen. Sichern Sie die vorhandene Dokumentation, indem Sie sie in einen externen Texteditor kopieren, bevor Sie diese Option verwenden. Nach der Regenerierung der Dokumentation wenden Sie manuell alle Anpassungen an, indem Sie sie bei Bedarf in den Editor einfügen.

• Speichern & Veröffentlichen: Klicken Sie, um die Änderungen an der Dokumentation für diese API nur auf der API-Portal Seite zu speichern und 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 des Tabs angezeigt.

  Nach dem Bearbeiten klicken Sie auf Speichern & Veröffentlichen, um die aktualisierte Dokumentation auf der API-Portal Seite 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 über den Dokumentation-Tab mit denselben Steuerungen zu testen, die in APIs testen auf der Portal Manager Seite beschrieben sind.