Proxy-API-Konfiguration im Jitterbit API Manager

Einführung

Diese Seite beschreibt, wie man eine Proxy-API auf der Seite APIs des Jitterbit API Manager erstellt und konfiguriert. Eine Proxy-API ist einer der drei API-Typen, die über den API Manager konfiguriert werden. Für die beiden anderen Typen, Custom API und OData-Service, siehe Custom-API-Konfiguration und OData-Service-Konfiguration.

Alternativ können Proxy-APIs mit dem APIM AI Assistant erstellt werden.

Voraussetzungen

Anders als eine Custom API oder ein OData-Service, die einen Harmony-Vorgang zur Nutzung verfügbar machen, wird eine Proxy-API mit einer vorhandenen API verwendet. Proxy-APIs werden nicht über Jitterbit-Agenten weitergeleitet. Das Gateway, das die API verarbeitet, muss auf die zu proxierende API zugreifen können:

• Cloud-API-Gateway: Wenn man das Cloud-API-Gateway (gehostet von Jitterbit) nutzt, muss die vorhandene API öffentlich zugänglich sein, auch wenn sie gesichert ist. Die API, die man proxieren möchte, darf sich nicht hinter einer Firewall befinden. Um die IP-Adressen des Cloud-API-Gateways auf eine Allowlist zu setzen und dem Gateway Zugriff auf die zu proxierende API zu ermöglichen, siehe Allowlist-Informationen und navigiere zu https://services.jitterbit für deine Region.

• Private API Gateway: Wenn man ein Private API Gateway (gehostet in einem privaten Netzwerk) nutzt, muss das Private API Gateway auf die vorhandene API zugreifen können.

Obwohl jede Proxy-API mehrere Services einer eindeutigen URL zuweisen kann, verbraucht die Basis-Proxy-URL die Berechtigung.

Neue Proxy-API erstellen

Um eine neue Proxy-API zu erstellen, klicke auf New und wähle eine der folgenden Optionen:

• Build with AI: Öffnet den APIM Assistant, um eine API mithilfe von Prompts in natürlicher Sprache zu erstellen. Weitere Informationen findest du unter Den AI Assistant verwenden.

  Hinweis

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

• Proxy API: Öffnet den Konfigurationsbildschirm für die Proxy-API, um eine neue Proxy-API manuell zu erstellen. Diese Option ist nur verfügbar, wenn eine entsprechende API-URL vorhanden ist.

Proxy-API konfigurieren

Bei der manuellen Konfiguration einer Proxy-API enthält der Konfigurationsbildschirm mehrere Registerkarten. Der Konfigurationsbildschirm enthält drei erforderliche Registerkarten und drei optionale Registerkarten:

• Registerkarte „Profile" (erforderlich)
• Registerkarte „Settings" (optional)
• Registerkarte „Existing API" (erforderlich)
• Registerkarte „Services" (erforderlich)
• Registerkarte „Security Profiles" (optional)
• Registerkarte „Request Headers" (optional)

Registerkarte „Profile"

Verwende die Registerkarte Profile, um grundlegende Informationen einzugeben, die die API identifizieren.

Konfiguriere die folgenden Einstellungen:

• API Name: Gib einen Namen für die Proxy-API ein, der zu internen Identifikationszwecken dient. Die folgenden Sonderzeichen sind zulässig: ( ) - _.

• Service Root: Der öffentliche Name der API, der als Teil der Service-URL der API verwendet wird. Standardmäßig wird dieses Feld mit dem Proxy Name gefüllt, der in Camel Case konvertiert wird. 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: Geben Sie eine optionale Beschreibung für die API ein.

• Umgebung: Verwenden Sie das Menü, um die Umgebung auszuwählen, in der sich die API befindet. Sie können einen beliebigen Teil des Umgebungsnamens in das Menü eingeben, um die Liste der Umgebungen zu filtern. Die Menüergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert.

  Hinweis

  Nach der API-Erstellung kann die Umgebung nicht mehr geändert werden. Um eine API zwischen Umgebungen zu verschieben, können Sie die API klonen oder die API in einer anderen Umgebung exportieren und importieren.

• Versionsnummer: Geben Sie eine optionale Version ein, die als Teil der Service-URL der API verwendet wird. Dieses Feld ermöglicht maximal 48 Zeichen und erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von Sonderzeichen außer einem Punkt (.) oder einem Bindestrich (-) wird nicht empfohlen. Zu den gängigen Namenskonventionen gehören inkrementelle Versionen wie v1.0, v1.1, v1.2 oder die Verwendung eines Datums, an dem die API veröffentlicht wurde, wie z. B. 2025-08-28.

Klicken Sie nach Abschluss der Registerkarte Profile auf Weiter, um zur Registerkarte Settings zu wechseln, oder klicken Sie auf Als Entwurf speichern, um den Fortschritt zu speichern.

Registerkarte „Settings"

Die Registerkarte Settings ist optional und enthält erweiterte Konfigurationsoptionen für die API.

Konfigurieren Sie die folgenden Einstellungen nach Bedarf:

• Timeout: Geben Sie die Anzahl der Sekunden ein, nach denen die API das Zeitlimit überschreitet. Der Standardwert liegt bei 30 Sekunden. Der maximal zulässige Wert ist 180 Sekunden.

  Hinweis

  Diese Einstellung ist unabhängig von der Timeout-Einstellung für Operationen in Studio oder Design Studio. Timeout-Einstellungen für Operationen werden nur verwendet, wenn die EnableAPITimeout-Einstellung in der Konfigurationsdatei des privaten Agenten aktiviert ist.

• Nur SSL: Dieser Schalter ist standardmäßig aktiviert und erfordert HTTPS für die API. Wenn aktiviert, werden Daten durch SSL verschlüsselt und eine HTTP-Anfrage gibt einen Fehler zurück. Wenn deaktiviert, werden sowohl HTTP- als auch HTTPS-Anfragen unterstützt.

  Warnung

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

• CORS: Aktivieren Sie diesen Schalter, um CORS (Cross-Origin Resource Sharing) zu unterstützen. CORS ist ein Mechanismus, der es Webanwendungen, die in einem Webbrowser auf einer Domäne ausgeführt werden, ermöglicht, auf Ressourcen von einem Server auf einer anderen Domäne zuzugreifen.

  Warnung

  Das Aktivieren von CORS führt dazu, dass Operationen mit der OPTIONS-Methode ohne Authentifizierung ausgeführt werden.

• Ausführliches Logging: Aktivieren Sie diesen Schalter, um unformatierte Anfrage- und Antwortdaten – einschließlich Header, Parameter und Textkörper – zum Anrufprotokoll hinzuzufügen, wenn eine API-Anfrage gestellt wird. Diese Daten werden auf der Seite API-Protokolle und der Seite Runtime der Management Console sowohl für erfolgreiche als auch für erfolglose Ausführungen angezeigt. Ausführliches Logging generiert keine Studio-Operationsprotokolle für erfolgreiche Ausführungen. Verwenden Sie stattdessen Debug-Modus aktivieren bis, um erfolgreiche Operationen in Studio zu protokollieren.

  Warnung

  Ausführliches Logging kann sensible Daten wie Authentifizierungsanmeldeinformationen oder persönlich identifizierbare Informationen enthalten. Werte für maskierte Header sind verborgen, aber Parameter und Textkörper werden vollständig protokolliert. Verwenden Sie diese Einstellung mit Bedacht.

• Debug-Modus aktivieren bis: Aktivieren Sie diesen Schalter, um detailliertes Logging zur Fehlerbehebung zu aktivieren. Klicken Sie dann auf das Kalendersymbol, um ein Datum auszuwählen, das bis zu zwei Wochen ab heute liegt. An diesem Datum wird der Debug-Modus automatisch deaktiviert. Wenn aktiviert, werden Anfrage- und Antwortdaten (werden 30 Tage lang aufbewahrt) auf der Seite API-Protokolle, der Seite Runtime der Management Console und Studio-Operationsprotokollen für erfolgreiche und erfolglose Ausführungen angezeigt. Das Debug-Logging auf Aktivitätsebene ist ebenfalls aktiviert und erfasst Eingabe- und Ausgabedaten von Komponenten auf der Registerkarte Debug-Protokollierung. Diese Einstellung setzt Ausführliches Logging außer Kraft: Wenn der Debug-Modus aktiviert ist, werden Anfrage- und Antwortdaten unabhängig davon in Protokollen aufgenommen, ob Ausführliches Logging aktiviert ist.

• Request & Response Payloads in Protokollen anzeigen: Diese Umschaltfläche ist in den Proxy-API-Einstellungen sichtbar, hat aber keine Auswirkung. Die Protokollierung von Request- und Response-Payloads wird für Proxy-APIs nicht unterstützt.

Klicken Sie nach der Konfiguration der Registerkarte Einstellungen auf Weiter, um zur Registerkarte „Existing API" zu wechseln, oder klicken Sie auf Zurück, um zur Registerkarte „Profile" zurückzukehren.

Registerkarte „Existing API"

Verwenden Sie die Registerkarte Existing API, um die Basis-URL der API anzugeben, die Sie als Proxy nutzen möchten, und stellen Sie optional ein OpenAPI-Dokument für die automatische Serviceerkennung bereit.

Konfigurieren Sie die folgenden Einstellungen:

• Base API URL: Geben Sie die Basis-URL der API ein, die als Proxy genutzt werden soll.

  Hinweis

  Wenn die API einen einzelnen Service bereitstellt, können Sie die vollständige API-URL einschließlich des Service-Pfads eingeben. Zusätzliche Service-Pfade werden auf der Registerkarte „Services" definiert.

• OpenAPI-Dokument bereitstellen: Wenn Sie ein OpenAPI-Dokument bereitstellen, nutzt der API Manager dieses zur automatischen Serviceerkennung. Wählen Sie Nein aus, um zu überspringen, oder Ja, um einen zusätzlichen Bereich zur Bereitstellung des OpenAPI-Dokuments zu erweitern:

  

  • URL laden: Öffnet ein Dialogfeld zum Laden eines OpenAPI-Dokuments im YAML- oder JSON-Format von einer URL:

    

  • Datei hochladen: Öffnet ein Dialogfeld zum Hochladen eines OpenAPI-Dokuments im YAML- oder JSON-Format, nachdem Sie mit Durchsuchen die Datei ausgewählt haben:

    

  • Löschen: Löscht ein bereits bereitgestelltes OpenAPI-Dokument und ändert die Auswahl OpenAPI-Dokument bereitstellen in Nein. Ein Bestätigungsdialogfeld Editor-Inhalte löschen wird angezeigt und fordert Sie auf zu bestätigen, bevor das Dokument entfernt wird. Das Löschen des Dokuments entfernt auch alle Services, die automatisch daraus erkannt wurden (siehe Automatische Erkennung von OpenAPI-Dokumenten), wirkt sich aber nicht auf manuell hinzugefügte Services oder andere API-Einstellungen aus. Das Löschen des Dokuments wird als nicht gespeicherte Änderung behandelt, bis Sie die API-Konfiguration speichern.

  • Dokument-Editor: Ermöglicht das Anzeigen und Bearbeiten eines bereitgestellten OpenAPI-Dokuments. Sie können ein OpenAPI-Dokument auch 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ückgabesymbol, um zu diesem Bildschirm zurückzukehren.

Klicken Sie nach der Konfiguration der Registerkarte Existing API auf Weiter, um zur Registerkarte „Services" zu wechseln, oder klicken Sie auf Zurück, um zur Registerkarte „Einstellungen" zurückzukehren.

Registerkarte „Services"

Verwenden Sie die Registerkarte Services, um die Services und HTTP-Methoden zu definieren, die die Proxy-API bereitstellen wird. Die Art und Weise, wie Sie Services definieren, hängt davon ab, ob Sie in der Registerkarte „Existing API" ein OpenAPI-Dokument bereitgestellt haben.

Manuelle Service-Definition

Wenn Sie kein OpenAPI-Dokument bereitgestellt haben, müssen Sie Services und Methoden manuell definieren:

Klicken Sie auf Neuer Service, um einen Service hinzuzufügen. Konfigurieren Sie die folgenden Einstellungen:

• Service-Name: Geben Sie einen Namen ein, um den Service zu identifizieren.

• Pfad: Geben Sie einen Pfad für den Service ein. Wenn die API keinen Service-Pfad hat, geben Sie einen Schrägstrich (/) ein. Um einen Pfadparameter zu definieren, setzen Sie seinen Namen in geschweifte Klammern (z. B. /pets/{petId}). Informationen zu den Zeichen und Limits, die ein Pfad akzeptiert, finden Sie unter Service-Pfad-Regeln.

• Methoden: Wählen Sie jede Methode aus, die für den Service erstellt werden soll. Verfügbare Methoden sind GET, PUT, POST und DELETE. Um eine nicht aufgelistete Methode zu verwenden, geben Sie den Methodennamen in das Textfeld Neue Methode eingeben ein und drücken Sie Enter.

• Aktionen: Bewegen Sie den Mauszeiger über eine Service-Zeile, um zusätzliche Aktionen anzuzeigen.

  • API-Service-URL kopieren: Klicken Sie, um die Service-URL der API zu kopieren.
  • Duplizieren: Klicken Sie, um den Service zu duplizieren.
  • Löschen: Klicken Sie, um den Service zu löschen.

Sie müssen mindestens einen Service hinzufügen, um zur nächsten Registerkarte zu gelangen.

OpenAPI-Dokument – automatische Erkennung

Wenn Sie ein OpenAPI-Dokument auf der Registerkarte „Vorhandene API" bereitgestellt haben, erkennt API Manager automatisch Services und listet sie in einer Tabelle auf:

• Zuweisen: Nutzen Sie den Umschalter, um die Services zur Proxy-API hinzuzufügen.
• Service-Name: Der Name zur Identifizierung des Service. Wenn das Dokument mehr als eine Methode für denselben Pfad definiert, enthält der Name die Methode (z. B. GET /pets und POST /pets), damit jeder Name eindeutig ist. Ein Pfad mit einer einzelnen Methode verwendet den Pfad als Namen.
• Methoden: Die HTTP-Methode, die für den Service gilt. Dieses Feld ist schreibgeschützt, da die Methoden aus dem OpenAPI-Dokument stammen.
• Pfad: Der Pfad des Service.

• Aktionen: Bewegen Sie den Mauszeiger über eine Service-Zeile, um zusätzliche Aktionen anzuzeigen.

  • API-Service-URL kopieren: Klicken Sie, um die Service-URL der API zu kopieren.

API Manager erkennt außerdem die Pfad-, Abfrage- und Header-Parameter, die das Dokument für jeden Pfad und jede Methode definiert, und listet sie auf den Service-Parameter-Registerkarten auf.

Service-Parameter

Wählen Sie eine Service-Zeile aus, um sie zu erweitern und die Parameter für diesen Service anzuzeigen. Parameter werden für jede Kombination aus Pfad und HTTP-Methode gespeichert. Wenn ein Service mehr als eine Methode hat, wird eine Registerkarte für jede Methode (z. B. GET und POST) über den Parameter-Registerkarten angezeigt, und jede Methoden-Registerkarte hat ihre eigenen Parameter.

Die Einstellung Erforderlich für Abfrageparameter und Header markiert einen Parameter in API Manager und im API Portal als erforderlich. Das API Portal hindert Sie daran, eine Anfrage zu testen, die einen erforderlichen Parameter auslässt. Das API-Gateway prüft beim Weiterleiten von Anfragen an die vorhandene API nicht auf erforderliche Parameter, daher muss die vorhandene API diese validieren.

Registerkarte „Pfad-Parameter"

Diese Registerkarte listet die Pfad-Parameter für den Service auf:

• Parameter: Der Name jedes Pfad-Parameters. API Manager fügt automatisch einen Parameter für jeden Namen hinzu, den Sie im Feld Pfad in geschweifte Klammern setzen, nach den Service-Pfad-Regeln. Dieses Feld ist schreibgeschützt. Ein Consumer muss beim Aufrufen des Service einen Wert für jeden Pfad-Parameter angeben.

• Beschreibung: Ein schreibgeschütztes Feld. API Manager speichert keine Beschreibungen für Pfad-Parameter.

Registerkarte „Abfrage-Parameter"

Diese Registerkarte listet die Abfrage-Parameter für den Service auf. Abfrage-Parameter werden aus einem OpenAPI-Dokument erkannt oder manuell hinzugefügt:

• Parameter hinzufügen: Klicken Sie, um einen Abfrage-Parameter zum Service hinzuzufügen. Die folgenden Felder werden verfügbar:

  • Parameter: Geben Sie den Namen des Abfrage-Parameters ein. Informationen zu zulässigen Zeichen und Länge finden Sie unter Parameter-Namen-Regeln.

  • Beschreibung: Geben Sie optional eine Beschreibung des Abfrage-Parameters ein.

  • Erforderlich: Nutzen Sie den Umschalter, um den Abfrage-Parameter als erforderlich zu markieren. Standardmäßig ist diese Option deaktiviert.

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

Registerkarte „Header"

Diese Registerkarte listet die Request-Header auf, die Consumer zum Service senden können. Diese Header beschreiben, was die vorhandene API akzeptiert. Um Header-Werte festzulegen, die API Manager zur vorhandenen API sendet, nutzen Sie stattdessen die Registerkarte „Request-Header".

• Parameter hinzufügen: Klicken Sie hier, um einen Request-Header zum Service hinzuzufügen. Die folgenden Felder werden verfügbar:

  • Parameter: Geben Sie den Namen des Request-Headers ein. Informationen zu zulässigen Zeichen und Länge finden Sie unter Regeln für Parameternamen.

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

  • Erforderlich: Verwenden Sie den Schalter, um anzugeben, dass Consumer den Header senden müssen. Die Standardeinstellung ist deaktiviert.

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

Regeln für Parameternamen

API Manager prüft Parameternamen und Beschreibungen bei der Bearbeitung. Sie müssen alle Fehler beheben, bevor Sie die API veröffentlichen können:

• Parameternamen dürfen nicht leer oder innerhalb des gleichen Tabs doppelt vorkommen.
• Parameternamen dürfen 64 Zeichen nicht überschreiten, und Beschreibungen dürfen 256 Zeichen nicht überschreiten.
• Query-Parameternamen dürfen nur Buchstaben, Zahlen und die Zeichen -, . und _ enthalten.
• Header-Parameternamen dürfen nur englische Buchstaben, Zahlen und die Zeichen !, #, $, %, &, ', *, +, -, ., ^, _, `, | und ~ enthalten.

Regeln für Service-Pfade

API Manager prüft den Pfad jedes Service, egal ob Sie ihn manuell eingeben oder er aus einem OpenAPI-Dokument stammt. Ein Fehler wird unter dem Feld Pfad angezeigt, und Sie müssen ihn beheben, bevor Sie die API veröffentlichen können. Ein Pfad muss diese Regeln befolgen:

• Der Pfad beginnt mit einem Schrägstrich (/). API Manager fügt den Schrägstrich automatisch hinzu.
• Der Pfad darf 2000 Zeichen nicht überschreiten.
• Jedes Textsegment des Pfads (die Teile außerhalb der geschweiften Klammern) darf nur Buchstaben, Zahlen und die Zeichen -, _ und . enthalten. Buchstaben und Zahlen können aus jeder Sprache stammen.
• Ein Pfad darf keine leeren Segmente enthalten (//).
• Geschweifte Klammern müssen paarweise vorhanden sein und dürfen nicht verschachtelt oder leer sein. Ein Pfadparametername in den Klammern folgt den gleichen Zeichenregeln wie Textsegmente und darf 64 Zeichen nicht überschreiten. Ein Pfad darf einen Parameternamen nicht zweimal verwenden.
• Ein Pfad kann mit einem Schrägstrich enden, und Text und Parameter können sich ein Segment teilen (z. B. /report.{format}).
• Ein Service kann den Basispfad (/) ohne zusätzliches Segment verwenden, und der Basispfad kann mehrere Methoden haben.

Nach der Konfiguration des Tabs Services klicken Sie auf Weiter, um zum Tab „Sicherheitsprofile" zu gehen, oder klicken Sie auf Zurück, um zum Tab „Vorhandene API" zurückzukehren.

Tab „Sicherheitsprofile"

Der Tab Sicherheitsprofile ist optional und ermöglicht es Ihnen, den Zugriff auf die API einzuschränken.

Konfigurieren Sie die folgenden Einstellungen:

• Zuweisen: Verwenden Sie den Schalter, um Sicherheitsprofile für die API zuzuweisen oder zu entfernen.

• Profilname: Der Name des Sicherheitsprofils wie in Sicherheitsprofile konfiguriert.

• Typ: Der Authentifizierungstyp für das Sicherheitsprofil, z. B. Basic, OAuth 2.0 oder API Key.

• Benutzername: Für die Basis-Authentifizierung wird hier der Benutzername angezeigt. Für andere Authentifizierungstypen wird der gleiche Wert wie in der Spalte Typ angezeigt.

• Aktionen: Bewegen Sie den Mauszeiger über eine Sicherheitsprofilzeile, um zusätzliche Aktionen anzuzeigen.

  • Zum Sicherheitsprofil gehen: Klicken Sie, um die Konfiguration des Sicherheitsprofils zu öffnen.

Je nach Richtlinien der Harmony-Organisation müssen Sie möglicherweise ein Sicherheitsprofil zuweisen, um die API zu speichern.

Klicke auf Neues Sicherheitsprofil, um ein neues Sicherheitsprofil zu erstellen. Anweisungen findest du unter Sicherheitsprofile konfigurieren.

Nachdem du die Registerkarte Sicherheitsprofile konfiguriert hast, klicke auf Weiter, um zur Registerkarte „Anforderungsheader" zu wechseln, oder klicke auf Zurück, um zur Registerkarte „Dienste" zurückzukehren.

Registerkarte „Anforderungsheader"

Die Registerkarte Anforderungsheader ist optional und ermöglicht es dir, neue Anforderungsheader hinzuzufügen oder vorhandene Anforderungsheader zu überschreiben.

Klicke auf Neuer Header, um einen Anforderungsheader hinzuzufügen. Konfiguriere die folgenden Einstellungen:

• Schlüssel: Gib einen Schlüssel für den Anforderungsheader ein. Der Schlüssel darf nur Buchstaben, Zahlen, Bindestriche (-) und Unterstriche (_) enthalten. Leerzeichen, Mehrbytezeichen und andere Sonderzeichen sind nicht zulässig.

• Wert: Gib einen Wert für den Anforderungsheader ein. Der Wert darf nur druckbare ASCII-Zeichen (Buchstaben, Zahlen und Standardpunktuation) enthalten, ohne führende oder nachfolgende Leerzeichen, und darf 8192 Zeichen nicht überschreiten. Mehrbytezeichen und Steuerzeichen sind nicht zulässig. Dies ermöglicht Werte wie JSON Web Tokens (JWTs), die Punkte (.) als Teil ihres Formats benötigen.

• Eingehende Anforderungen überschreiben: Aktiviere diese Umschaltfläche, um einen vorhandenen Anforderungsheader zu überschreiben, der denselben Schlüssel verwendet. Die Standardeinstellung ist deaktiviert.

• Aktionen: Fahre mit der Maus über eine Header-Zeile, um zusätzliche Aktionen anzuzeigen.

  • Löschen: Klicke hier, um den Anforderungsheader zu löschen.

Nachdem du die Registerkarte Anforderungsheader konfiguriert hast, klicke auf Veröffentlichen, um die API zu veröffentlichen, oder klicke auf Als Entwurf speichern, um den Fortschritt zu speichern.

Optionen zum Speichern und Veröffentlichen

Nachdem du alle erforderlichen Registerkarten konfiguriert hast, kannst du die API speichern oder veröffentlichen:

• Als Entwurf speichern: Speichert die API mit dem Status Entwurf oder Veröffentlicht mit Entwurf. Entwurfs-APIs werden nicht auf dein Abonnement für Proxy-URL angerechnet. Eine API, deren Status zum Zeitpunkt der Verwendung von Als Entwurf speichern Veröffentlicht war, wird als Veröffentlicht mit Entwurf gespeichert. Eine veröffentlichte API wird auf dein Abonnement für Proxy-URL angerechnet, obwohl auf ihren Entwurf nicht zugegriffen werden kann.

• Veröffentlichen: Speichert die API mit dem Status Veröffentlicht. Die API ist live und innerhalb von fünf Minuten erreichbar. Eine veröffentlichte API wird auf dein Abonnement für Proxy-URL angerechnet. Ein Dialogfeld gibt an, dass die API live ist:

  

  Das Dialogfeld bietet diese Optionen:

  • URL kopieren: Kopiert die Service-URL der API in die Zwischenablage.
  • Schließen: Schließt das Dialogfeld.

API bearbeiten

Nach dem Speichern der API kannst du sie von diesen Positionen aus bearbeiten:

• Verwende die Kartenansicht auf der Seite „APIs" und klicke auf die Karte.
• Verwende die Listenansicht auf der Seite „APIs" und klicke auf Bearbeiten in der Spalte Aktionen.

Wenn du eine veröffentlichte API aus der Listenansicht bearbeitest, ist auch eine Registerkarte Dokumentation verfügbar. Verwende diese Registerkarte, um die OpenAPI-Dokumentation für einzelne APIs anzuzeigen, zu bearbeiten und zu veröffentlichen. Details findest du unter Registerkarte „Dokumentation" auf der Seite „APIs".

Fehlerbehebung

Informationen zur Fehlerbehebung findest du in den folgenden Abschnitten im API Manager-Leitfaden zur Fehlerbehebung:

• Cloud-Proxy-API: Ziel-API muss öffentlich zugänglich sein

• Proxy-API: Bindestriche in Request-Headern werden durch Unterstriche ersetzt

• Einstellung „Request & Response Payloads anzeigen" hat keine Auswirkung auf Proxy-APIs