OData API-Konfiguration im Jitterbit API Manager

Einführung

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

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

OData APIs (veröffentlicht und Entwurf) werden an diesen Orten angezeigt:

• Auf der APIs Seite des API Managers.
• Im Ressourcen-Tab des Projektfensters für das mit der OData API verbundene Design Studio-Projekt.

Voraussetzungen

Eine OData API stellt eine Jitterbit iPaaS API-Entitätsoperation zur Verfügung. Sie müssen zunächst diese Operation erstellen und bereitstellen, bevor Sie die OData API konfigurieren können. Die Operation, die eine OData API auslöst, muss eine API-Entitätsoperation im Design Studio sein.

Für Informationen zur Erstellung und Bereitstellung einer API-Entitätsoperation im Design Studio siehe diese Ressourcen:

• Schnellstartanleitung für das Design Studio
• Erstellen einer Jitterbit-Entität
• Erstellen einer API-Entitätsoperation

Erstellen einer neuen OData-API

Um eine neue OData-API zu erstellen, klicken Sie auf Neu und wählen Sie eine der folgenden Optionen:

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

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

Konfigurieren einer OData-API

Wenn Sie eine OData-API manuell konfigurieren, enthält der Konfigurationsbildschirm mehrere Registerkarten. Der Konfigurationsbildschirm umfasst zwei erforderliche Registerkarten und drei optionale Registerkarten:

• Profil-Registerkarte (erforderlich)
• Einstellungen-Registerkarte (optional)
• Dienste-Registerkarte (erforderlich)
• Sicherheitsprofile-Registerkarte (optional)
• Benutzerrollen-Registerkarte (optional)

Profil-Registerkarte

Verwenden Sie die Profil-Registerkarte, um grundlegende Informationen einzugeben, die die API identifizieren.

Konfigurieren Sie die folgenden Einstellungen:

• API-Name: Geben Sie einen Namen für die API ein, der für interne Identifikationszwecke verwendet wird. Die folgenden Sonderzeichen sind erlaubt: ( ) - _.

• Service Root: Der öffentliche Name der API, der als Teil der API-Dienst-URL verwendet wird. Standardmäßig wird dieses Feld mit dem API-Namen gefüllt, der in camel case umgewandelt wurde. In diesem Feld sind keine Leerzeichen oder bestimmte Sonderzeichen erlaubt. Die Verwendung von Sonderzeichen außer einem Unterstrich (_) wird nicht empfohlen. Die folgenden Sonderzeichen sind erlaubt: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -.

• Description: Geben Sie eine optionale Beschreibung für die API ein.

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

  Hinweis

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

• Version number: Geben Sie eine optionale Version ein, die als Teil der API-Dienst-URL 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 inkrementierende Versionen wie v1.0, v1.1, v1.2 oder die Verwendung eines Datums, an dem die API veröffentlicht wurde, wie 2025-08-28.

Nachdem Sie die Profil-Registerkarte abgeschlossen haben, klicken Sie auf Weiter, um zur Einstellungen-Registerkarte zu gelangen, oder klicken Sie auf Als Entwurf speichern, um Ihren Fortschritt zu speichern.

Settings tab

Die Einstellungen-Registerkarte 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, bevor die API eine Zeitüberschreitung hat. Der Standardwert beträgt 30 Sekunden. Der maximal erlaubte Wert beträgt 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 nicht verwendet, es sei denn, ein privater Agent wird verwendet und die Einstellung EnableAPITimeout in der Konfigurationsdatei des privaten Agents ist aktiviert.

• Nur SSL: Dieser Schalter ist standardmäßig aktiviert und erfordert HTTPS für die API. Wenn aktiviert, werden Daten über 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, 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 offenbaren.

• 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 Domain ausgeführt werden, ermöglicht, auf Ressourcen von einem Server auf einer anderen Domain zuzugreifen.

  Warnung

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

• Ausführliches Protokollieren: Aktivieren Sie diesen Schalter, um Anforderungsheader und Payloads zu protokollieren, wenn eine API-Anfrage gestellt wird.

  Warnung

  Ausführliches Protokollieren kann sensible Daten wie Authentifizierungsanmeldeinformationen oder personenbezogene Informationen enthalten. Verwenden Sie diese Einstellung mit Vorsicht.

• Debug-Modus aktivieren bis: Aktivieren Sie diesen Schalter, um detailliertes Protokollieren zur Fehlersuche zu aktivieren, und klicken Sie dann auf das Kalendersymbol, um ein Datum bis zu zwei Wochen ab heute auszuwählen, an dem der Debug-Modus automatisch deaktiviert wird. Wenn Sie den Debug-Modus für durch diese API ausgelöste Operationen aktivieren, enthalten die API-Protokolle Anforderungs- und Antwortdaten (30 Tage lang aufbewahrt), auf die Sie über die Management Console Runtime Seite zugreifen können. Standardmäßig protokolliert der API-Manager nur API-Operationen mit Fehlern.

  Warnung

  Debugprotokolle enthalten alle Anforderungs- und Antwortdaten, einschließlich sensibler Informationen wie Passwörter und personenbezogene Daten (PII). Diese Daten erscheinen im Klartext in den Harmony-Cloud-Protokollen für 30 Tage.

Nachdem Sie die Einstellungen-Registerkarte konfiguriert haben, klicken Sie auf Weiter, um zur Dienste-Registerkarte zu gelangen, oder klicken Sie auf Zurück, um zur Profil-Registerkarte zurückzukehren.

Dienste-Registerkarte

Die Dienste-Registerkarte ist der Ort, an dem Sie die API-Dienste konfigurieren, die definieren, wie die API auf Anfragen reagiert. Für OData-APIs weisen Sie Jitterbit-Entitätsoperationen zu, die Daten über das OData-Protokoll bereitstellen.

Klicken Sie auf Neuer Dienst, um einen neuen API-Dienst hinzuzufügen. Konfigurieren Sie die folgenden Einstellungen für jeden Dienst:

• Entität: Wählen Sie aus den bereitgestellten Projekten, die eine Design Studio API-Entitätsoperation in der Umgebung enthalten, in der Sie die API konfigurieren. Der Entitätsname entspricht dem Projektnamen im Design Studio.

• Projekt: Zeigt den Projektnamen des Design Studios an, der die ausgewählte Entität enthält.

• Operation: Wählen Sie aus den bereitgestellten Design Studio API-Entitätsoperationen in der ausgewählten Entität. Es kann nur eine Operation mit jeder Methode zugewiesen werden.

  Wichtig

  Standardmäßig sind erfolgreiche Operationen, die für eine OData-API konfiguriert sind, nicht in den Betriebsprotokollen enthalten, es sei denn, eine dieser Einstellungen ist aktiviert:

  • Cloud-Agenten: Für API-Operationen auf einem Cloud-Agenten muss das Betriebsdebugprotokoll für die Operation aktiviert sein.
  • Private Agenten: Für API-Operationen auf einem privaten Agenten muss entweder das Betriebsdebugprotokoll für die Operation aktiviert sein oder Sie müssen EnableLogging=true im Abschnitt [APIOperation] der Konfigurationsdatei des privaten Agenten festlegen.

  Fehlgeschlagene Operationen werden in den Operationsprotokollen protokolliert, unabhängig davon, ob die oben genannten Einstellungen aktiviert sind oder nicht.

• Methode: Wählen Sie die HTTP-Methode aus, die für die ausgewählte Operation erstellt werden soll. Verfügbare Methoden sind GET, PUT, POST, DELETE, PATCH, MERGE oder ALL. Die Auswahl von ALL erstellt separate GET-, PUT-, POST-, DELETE-, PATCH- und MERGE-Methoden für die ausgewählte Operation. Um eine nicht aufgeführte Methode zu verwenden, geben Sie den Methodennamen im Textfeld Type a new method ein und drücken Sie Enter.

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

  • API-Dienst-URL kopieren: Klicken Sie, um die API-Dienst-URL zu kopieren.
  • Zum API-Dienst gehen: Klicken Sie, um eine Übersicht über die Konfiguration der OData-API auf einer einzelnen Seite zu sehen.
  • Duplizieren: Klicken Sie, um den API-Dienst zu duplizieren.
  • Löschen: Klicken Sie, um den API-Dienst zu löschen.

Sie können mehrere Dienste für eine einzelne OData-API konfigurieren. Sie müssen mindestens eine Entität hinzufügen, um zum nächsten Tab zu gelangen.

Nachdem Sie den Tab Dienste konfiguriert haben, klicken Sie auf Weiter, um zum Tab Sicherheitsprofile zu gelangen, oder klicken Sie auf Zurück, um zum Tab Einstellungen zurückzukehren.

Tab Sicherheitsprofile

Der Tab Sicherheitsprofile ist optional und ermöglicht es Ihnen, den Zugriff auf die Nutzung der 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 im Sicherheitsprofile konfiguriert.

• Typ: Der Authentifizierungstyp für das Sicherheitsprofil, wie Basic, OAuth 2.0 oder API-Schlüssel.

• Benutzername: Bei der grundlegenden Authentifizierung wird der Benutzername angezeigt. Bei anderen Authentifizierungstypen wird derselbe Wert wie in der Spalte Typ angezeigt.

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

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

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

Klicken Sie auf Neues Sicherheitsprofil, um ein neues Sicherheitsprofil zu erstellen. Für Anweisungen siehe Sicherheitsprofile konfigurieren.

Nachdem Sie die Registerkarte Sicherheitsprofile konfiguriert haben, klicken Sie auf Weiter, um zur Benutzerrollen-Registerkarte zu gelangen, oder klicken Sie auf Zurück, um zur Dienste-Registerkarte zurückzukehren.

Benutzerrollen-Registerkarte

Die Registerkarte Benutzerrollen ist optional und bestimmt, welche Organisationsrollen Zugriff auf die API innerhalb des API-Managers haben.

Konfigurieren Sie die folgenden Einstellungen:

• Benutzerrolle: Der Name der Organisationsrolle, wie auf der Registerkarte Rollen der Benutzerverwaltungsseite definiert.

• Berechtigungen: Die diesem Rolle zugewiesenen Berechtigungen, wie Lesen oder Admin.

• Status: Gibt an, ob die Rolle dieser API zugewiesen ist. Schalten Sie den Status um, um Rollen zuzuweisen oder abzulehnen.

• Aktionen: Fahren Sie mit der Maus über eine Zeile der Benutzerrolle, um zusätzliche Aktionen anzuzeigen.

  • Zur Benutzerrolle gehen: Klicken Sie, um die Konfiguration der Benutzerrolle zu öffnen.

Die Rollen, die Sie hier auswählen, bestimmen den Zugriff auf diese spezifische API von diesen Seiten:

• APIs
• Portal Manager, einschließlich der Erstellung von API-Dokumentationen
• API Portal
• API Logs
• Analytics

Der Zugriff auf die Seite Security Profiles und der Zugriff zur Nutzung der API sind von dieser Auswahl nicht betroffen. Der Zugriff zur Nutzung einer API wird durch Sicherheitsprofile gesteuert.

Alle definierten Benutzerrollen mit der Berechtigung Admin haben immer vollen Zugriff auf alle APIs und können daher nicht von der Auswahl entfernt werden.

Klicken Sie auf Neue Benutzerrolle, um eine neue Benutzerrolle zu erstellen. Für Anweisungen siehe Rollen in Benutzerverwaltung.

Nachdem Sie die Registerkarte Benutzerrollen konfiguriert haben, klicken Sie auf Veröffentlichen, um die API zu veröffentlichen, oder klicken Sie auf Als Entwurf speichern, um Ihren Fortschritt zu speichern.

Optionen zum Speichern und Veröffentlichen

Nachdem Sie alle erforderlichen Registerkarten konfiguriert haben, können Sie die API speichern oder veröffentlichen:

• Als Entwurf speichern: Speichert die API im Status Entwurf oder Veröffentlicht mit Entwurf. Entwurfs-APIs zählen nicht gegen Ihr API URL-Abonnementlimit. 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 zählt gegen Ihr API URL-Abonnementlimit, auch wenn ihr Entwurf nicht zugänglich ist.

• Veröffentlichen: Speichert die 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 API URL-Abonnementlimit. Ein Dialog zeigt an, dass die API live ist:

  

Die Dialogbox bietet diese Optionen:

• URL kopieren: Kopiert die Service-URL der API in Ihre Zwischenablage.
• OpenAPI-Dokument generieren: Öffnet die Seite Portal Manager. Beachten Sie, dass Sie OpenAPI-Dokumentationen nur für benutzerdefinierte APIs generieren können, nicht für OData-APIs.
• Schließen: Schließt die Dialogbox.

OData-Abfrageparameter

Sie können die zurückgegebenen Daten filtern, indem Sie OData-Abfrageparameter an eine OData-API-Service-URL anhängen. Die spezifischen unterstützten Abfrageparameter hängen von der zugrunde liegenden Datenbank ab.

Häufige OData-Abfrageparameter sind:

https://jbexample.jitterbit.net/Sandbox/customers?$top=10&$orderby=name

API bearbeiten

Nachdem Sie die API gespeichert haben, können Sie sie von diesen Standorten aus bearbeiten:

• Verwenden Sie die Kachelansicht auf der APIs-Seite, klicken Sie auf Anzeigen/Bearbeiten.
• Verwenden Sie die Listenansicht auf der APIs-Seite, klicken Sie auf Bearbeiten in der Spalte Aktionen.