Zum Inhalt springen

Verwandeln Sie Ihre Kontakte in Urlaubsgeld mit unserem neuen Kundenempfehlungsprogramm! Erfahren Sie mehr

✕

OData-Dienstkonfiguration im Jitterbit API-Manager

Einführung

Auf dieser Seite wird beschrieben, wie Sie einen OData-Dienst aus den APIs erstellen und konfigurieren Seite von Jitterbit API-Manager. Ein OData Dienst ist einer der drei APIs-Typen über den API-Manager konfiguriert. Informationen zu den beiden anderen Typen - benutzerdefinierte API und Proxy-API - finden Sie unter Custom API Konfiguration oder Proxy-API Konfiguration.

Notiz

Nach der Veröffentlichung zählt jeder OData Dienst als API-URL zu Ihrem Harmony Abonnementkontingent.

Voraussetzungen

Da ein OData Dienst eine Jitterbit iPaaS API Operation zur Nutzung bereitstellt, muss diese Operation zunächst erstellt und bereitgestellt werden. Die Operation, die ein OData-Dienst auslöst, muss eine Design Studio API Operation sein. Auf die vorhandene API Operation wird dann während der Konfiguration des OData Dienstes verwiesen. Auf dieser Seite wird das Wort API verwendet, um auf einen OData Dienst zu verweisen.

Informationen zum Erstellen und Bereitstellen einer API Operation in Design Studio finden Sie in den folgenden Ressourcen:

Erstellen eines neuen OData-Dienstes

Wenn Sie auf den API-ManagerAPIs zugreifen-Seite: Wenn in der ausgewählten Organisation keine benutzerdefinierten APIs, OData-Dienste oder Proxy-APIs vorhanden sind, ist dieser Bildschirm leer.

Um einen neuen OData-Dienst zu erstellen, klicken Sie auf Neu > Custom API:

keine APIs neue API

Wenn Sie auf Custom API klicken, wird der API-Konfigurationsbildschirm geöffnet. Details zur Konfiguration eines neuen OData Dienstes finden Sie unter OData Dienst konfigurieren unten.

Konfigurieren eines OData-Dienstes

Der Konfigurationsbildschirm umfasst vier Konfigurationsschritte, die im Folgenden beschrieben werden:

Die Service-URL einer API ist die URL, die zur Nutzung der API mithilfe einer konfigurierten Authentifizierungsmethode verwendet wird. Die Bestandteile der Service-URL einer API werden unter API-Manager - Erste Schritte beschrieben. in API -Dienst URL.

Die Service URL wird oben in jedem Schritt angezeigt:

Neue API Schritt-1-Einstellungen-Service-URL veröffentlichen

Schritt 1: Einstellungen

Neue API Einstellungen für Schritt 1 veröffentlichen

  • API -Name: Geben Sie einen Namen für die API ein, der zur internen Identifikation verwendet werden soll. Folgende Sonderzeichen sind zulässig:

    ( ) - _

  • Umgebung: Wählen Sie über das Menü die Umfeld aus, in der die API gespeichert werden soll. Sie können einen beliebigen Teil des Umfeld in das Menü eingeben, um die Liste der Umgebungen zu filtern. Die Menüergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert.

    Notiz

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

  • Service-Root: Der öffentliche Name der API, der als Teil der Service-URL der API verwendet werden soll. Standardmäßig wird dieses Feld mit dem API -Namen in Camel Case ausgefüllt. Dieses Feld erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als Unterstriche (_) wird nicht empfohlen. Folgende Sonderzeichen sind zulässig:

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

  • Version: Geben Sie eine optionale Version ein, die als Teil der Service-URL der API verwendet werden soll. Dieses Feld ist auf maximal 48 Zeichen begrenzt und erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als Punkte (.) oder ein Bindestrich (-) wird nicht empfohlen. Gängige Namenskonventionen umfassen inkrementelle Versionen, wie z. B. v1.0, v1.1, v1.2oder mithilfe eines Datums, an dem die API veröffentlicht wurde, wie etwa 2021-08-28.

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

  • Timeout: Geben Sie die Anzahl der Sekunden ein, nach denen die API abläuft. Der Standardwert beträgt 30 Sekunden. Das Maximum beträgt 180 Sekunden.

    Notiz

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

  • Nur SSL: Wenn ausgewählt (Standard), werden die Daten über SSL verschlüsselt und HTTPS wird für alle API Anfragen und-Antworten erzwungen (empfohlen).

    Wenn diese Option nicht aktiviert ist, werden die über API Anfragen und-Antworten übermittelten Daten nicht verschlüsselt und können von anderen abgefangen und eingesehen werden. Dies könnte möglicherweise vertrauliche Informationen offenlegen.

  • CORS aktivieren: Auswählen, um Cross-Origin Resource Sharing (CORS) zu aktivieren (nicht empfohlen). CORS aktivieren ist standardmäßig ausgewählt.

    Warnung

    Die Aktivierung von CORS führt dazu, dass Operationen mit dem OPTIONS Methode zur Ausführung ohne Authentifizierung.

  • Ausführliche Protokollierung aktivieren: Aktivieren Sie diese Option, um die ausführliche Protokollierung zu aktivieren. Die ausführliche Protokollierung für APIs umfasst Anforderungs- und Antwortdaten in jedem API Protokoll, um die Überwachung eingehender und ausgehender Daten zu unterstützen und die Fehlerbehebung zu erleichtern. Da hierbei große Protokolldateien entstehen können, ist die ausführliche Protokollierung standardmäßig deaktiviert.

  • Debug-Modus aktivieren bis: Wählen Sie diese Option, um den debuggen-Modus zu aktivieren und ein entsprechendes Datum und eine Uhrzeit einzugeben, an denen der debuggen Modus deaktiviert wird. Die Aktivierungsdauer beträgt maximal zwei Wochen. Der Debug-Modus ermöglicht die vollständige Ablaufverfolgung aller über die Service-URL der API empfangenen Anfragen. Wenn aktiviert, speichert das System den vollständigen Inhalt jeder API Anfrage und-Antwort bis zu 24 Stunden ab dem Zeitpunkt des API -Aufrufs und gilt für alle von der API ausgelösten Vorgänge.

    Notiz

    Das Durchsuchen der Ereignisdaten kann bei großen Datenmengen (Lasttests, Vorproduktionstests usw.) schwierig werden. Die Zunahme der gespeicherten Daten kann zu Speicherplatz- und Sicherheitsproblemen führen. Wir empfehlen, den debuggen Modus in einer Umfeld nicht zu verwenden.

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren.

  • Änderungen speichern: Klicken Sie hier, um die Konfiguration für diesen Schritt zu speichern und zu Schritt 4: Zusammenfassung und Bestätigung zu navigieren.

Schritt 2: Servicetyp auswählen und Vorgänge zuweisen

Neue API veröffentlichen, Schritt 2, Jitterbit-Entitäten OData zuweisen

  • Diensttyp: Wählen Sie OData-Dienst.

  • Jitterbit-Entitäten zuweisen: Verwenden Sie die Dropdown-Menüs, um eine Entität (Projekt), Operation und Methode für den OData Dienst auszuwählen:

    • Entität (Projekt): Wählen Sie aus den bereitgestellten Projekten aus, die ein Design Studio API Operation enthalten in der Umfeld, in der die API konfiguriert wird.

    • Operation: Wählen Sie aus dem bereitgestellten Design Studio API Entitätsoperationen in der ausgewählten Entität (Projekt). Es kann nur ein Operation mit jeder Methode zugewiesen werden.

      Wichtig

      Standardmäßig werden erfolgreiche Vorgänge, die für einen OData-Dienst konfiguriert wurden, nicht in die Operation aufgenommen, sofern nicht eine dieser Einstellungen aktiviert ist:

      Nicht erfolgreiche Vorgänge werden in die Operation aufgenommen ob die oben genannten Einstellungen aktiviert sind oder nicht.

    • Methode: Wählen Sie eine der folgenden Optionen aus:GET, **PUT, POST, DELETE, PATCH, MERGE, oder ALL die Methode, die für die ausgewählte Operation erstellt werden soll. Auswählen ALL wird separate erstellen GET, PUT, POST, DELETE, PATCH, Und MERGE Methoden für die ausgewählte Operation.

  • Entität zuweisen: Sobald alle Dropdown-Menüs ausgefüllt sind, klicken Sie auf Entität zuweisen, um die Entität zur Tabelle unten hinzuzufügen. Mindestens eine Entität muss hinzugefügt werden, um die Schaltfläche Weiter zu aktivieren.

    Hinweis

    Nach dem Klicken auf Entität zuweisen können Sie den Diensttyp nicht mehr ändern.

  • Zugewiesene Entitäten: Eine Tabelle zeigt alle zugewiesenen Entitäten an. Um eine zugewiesene Entität zu entfernen, klicken Sie auf das Symbol „Entfernen“.

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren.

  • Änderungen speichern: Klicken Sie hier, um die Konfiguration für diesen Schritt zu speichern und navigieren Sie zu Schritt 4: Zusammenfassung und Bestätigung.

Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen

Neue API Schritt 3-Benutzerrollen-Sicherheitsprofile veröffentlichen

  • Benutzerrollen zuweisen: Wählen Sie auf den unten aufgeführten API-Manager Seiten die Organisationsrollen aus, deren Mitglieder Zugriff auf die API haben sollen. Zur Auswahl stehen die Rollen, die auf der Seite Benutzerverwaltung der Management Console definiert sind.

    Dies bestimmt den Zugriff auf diese spezielle API von diesen Seiten aus:

    Zugriff auf die Sicherheitsprofile und der Zugriff auf die API bleiben von dieser Auswahl unberührt. (Der Zugriff auf die API wird durch Sicherheitsprofile gesteuert.)

    Definierte Benutzerrollen mit der Berechtigung Admin haben immer vollen Zugriff auf alle APIs und können daher nicht aus der Auswahl gelöscht werden. (Im oben gezeigten Beispiel Screenshot können die Rollen Administrator und Operations daher nicht gelöscht werden.)

    Notiz

    Bei APIs, die vor Harmony 10.22 erstellt wurden, sind standardmäßig alle Benutzerrollen ausgewählt, um allen Benutzern fortlaufenden Zugriff zu gewährleisten.

  • Sicherheitsprofil(e) zuweisen: Wählen Sie aus der Dropdown-Liste ein vorhandenes Sicherheitsprofil aus, das den Zugriff auf die API einschränkt. Sie können einen beliebigen Teil des Sicherheitsprofilnamens in das Menü eingeben, um die Liste der Sicherheitsprofile zu filtern. Die Ergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert. Je nach den Richtlinien der Harmony Organisation kann die Zuweisung eines Sicherheitsprofils erforderlich sein, um die API zu speichern.

    • Profil zuweisen: Klicken Sie hier, um der API ein ausgewähltes Sicherheitsprofil zuzuweisen. Zugewiesene Sicherheitsprofile werden in der Tabelle mit dem Profilnamen und Typ aufgeführt, die für das Sicherheitsprofil in der Sicherheitsprofilkonfiguration konfiguriert wurden. Wenn der Typ Basic ist, wird in der Spalte Benutzername der während der Konfiguration angegebene Benutzername angezeigt. Wenn der Typ ein anderer Typ ist, wird in der Spalte Benutzername derselbe Wert wie der Typ angezeigt. Um ein zugewiesenes Profil zu entfernen, klicken Sie auf das Symbol „Entfernen“.

    • Neues Profil erstellen Klicken Sie hier, um ein neues Sicherheitsprofil zu erstellen. Anweisungen finden Sie unter Sicherheitsprofilkonfiguration.

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Wenn der API kein erforderliches Sicherheitsprofil zugewiesen ist, ist diese Option deaktiviert.

  • Änderungen speichern: Klicken Sie hier, um die Konfiguration für diesen Schritt zu speichern. Wenn der API kein erforderliches Sicherheitsprofil zugewiesen ist, ist diese Option deaktiviert.

  • Diesen Schritt überspringen: Klicken Sie hier, um mit dem nächsten Schritt fortzufahren, ohne die Konfiguration für diesen Schritt zu speichern. Wenn der API kein erforderliches Sicherheitsprofil zugewiesen ist, ist diese Option nicht vorhanden.

Schritt 4: Zusammenfassung und Bestätigung

Zusammenfassung von Schritt 4 der neuen API veröffentlichen

  • API -Name und Umgebung: Der API -Name gefolgt von der Umfeld in Klammern, wie in Schritt 1: Einstellungen konfiguriert.

    • Beschreibung, Timeout, Nur SSL, CORS aktiviert und Ausführliche Protokollierung aktiviert: Die API Beschreibung und andere aktivierte Einstellungen () oder deaktiviert (). Um Änderungen an diesen Einstellungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 1: Einstellungen zurückzukehren.
    • Debug-Modus aktivieren bis: Diese Option entspricht der in Schritt 1: Einstellungen beschriebenen. Sie können diese Einstellung direkt in diesem Schritt ändern, ohne zum ersten Schritt zurückkehren zu müssen.

  • Operationen: Die in Schritt 2: Servicetyp auswählen und Operationen zuweisen zugewiesenen Operationen mit den entsprechenden Informationen zum ausgewählten Servicetyp. Um Änderungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 2: Servicetyp auswählen und Vorgänge zuweisen zurückzukehren.

  • Benutzerrollen und Sicherheitsprofile: Die in Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen zugewiesenen Rollen und Sicherheitsprofile. Um Änderungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen zurückzukehren.

  • Export: Generiert und startet den Download einer APK-Datei (apis-export.apk), die einen Export der API enthält (siehe Exportieren und Importieren von APIs).

  • Klonen: Erstellt eine Kopie einer vorhandenen API. In der API Kopie wird dem API -Namen die Zeichenfolge Kopie von, dem Service-Root die Zeichenfolge Kopie von und der Version die Zeichenfolge -2 vorangestellt. Die API Kopie wird sofort in einem eigenen Fenster geöffnet. Schritt 4: Zusammenfassung und Bestätigung.

  • Löschen: Löscht die API dauerhaft und schließt die Konfiguration. Sie werden in einem Dialogfeld aufgefordert, das Löschen der API zu bestätigen.

    Notiz

    Wenn die API zum Zeitpunkt der Löschung den Status Veröffentlicht oder Veröffentlicht mit Entwurf hatte, wird sie auch von der Anzahl der auf Ihr Abonnementlimit angerechneten API-URLs abgezogen. Wenn die API zum Zeitpunkt der Löschung den Status Entwurf hatte, ändert sich die Anzahl der auf Ihr Abonnementlimit angerechneten API-URLs nicht, da die API im Status Entwurf nicht zugänglich war.

  • Als Entwurf speichern: Speichert die API im Status Entwurf oder Mit Entwurf veröffentlicht:

  • Entwurf: Eine neue API oder eine API, die zum Zeitpunkt der Verwendung von Als Entwurf speichern den Status Entwurf hatte. Entwürfe werden nicht auf Ihr API-URL-Abonnementlimit angerechnet.

  • Veröffentlicht als Entwurf: Eine API, deren Status zum Zeitpunkt von Als Entwurf speichern Veröffentlicht war, wird verwendet. Eine als Entwurf veröffentlichte API wird auf Ihr API-URL-Abonnementlimit angerechnet, da die API zugänglich ist, der Entwurf jedoch nicht.

  • Speichern und Veröffentlichen: Speichert die API im Status Veröffentlicht. Die API ist innerhalb von fünf Minuten verfügbar. Eine veröffentlichte API wird auf Ihr API-URL-Abonnementlimit angerechnet, da die API verfügbar ist. Ein Dialog zeigt an, dass die API verfügbar ist:

    alles eingestellt, Ihre API ist eine benutzerdefinierte Live API

  • URL kopieren: Kopiert die Service URL der API (siehe API Service-URL).

  • OpenAPI-Dokument generieren: Öffnet den Portal Manager Seite, auf der Sie API Dokumentation für das Portal generieren können Seite. Obwohl dieser Link für OData Dienste angezeigt wird, kann OpenAPI-Dokumentation für benutzerdefinierte APIs generiert werden nur.
  • Ablehnen: Schließt den Dialog.

OData-Dienstabfragen

Abhängig von der Datenbank können Sie die zurückgegebenen Daten filtern, indem Sie OData Abfrage anhängen (wie zum Beispiel $count, $inlinecount, Und $filter) zu einer OData-Service-URL.

Hinweis

Wenn keine Daten mit einem übereinstimmen $inlinecount oder $count Abfrage gibt der OData-Dienst standardmäßig einen Fehler zurück. Wenn Sie die Agentenversion 11.32 oder höher verwenden, können Sie $noErrorOnZeroCount Zu true zurückkehren 0(anstelle eines Fehlers) für $count Systemabfragen.