OData Dienstkonfiguration im Jitterbit API-Manager

Einführung

Auf dieser Seite wird beschrieben, wie Sie über Meine APIs einen OData-Dienst 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.

Voraussetzungen

Da ein OData Dienst eine Jitterbit iPaaS API Operation zur Nutzung bereitstellt, muss eine solche Operation zuerst 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:

• Design Studio Kurzanleitung
• Eine Jitterbit-Entität erstellen
• Eine API Operation erstellen

Einen neuen OData-Dienst erstellen

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

Um einen neuen OData-Dienst zu erstellen, klicken Sie auf Neue API:

Wenn Sie auf Neue API klicken, wird der Konfigurationsbildschirm des OData Dienstes geöffnet. Einzelheiten zum Konfigurieren eines neuen OData Dienstes finden Sie unter Konfigurieren eines OData-Dienstes unten.

Konfigurieren eines OData-Dienstes

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

• Schritt 1: Einstellungen
• Schritt 2: Servicetyp auswählen und Vorgänge zuweisen
• Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen
• Schritt 4: Zusammenfassung und Bestätigung

Die Service URL einer API ist die URL, die zum Verwenden der API mithilfe einer konfigurierten Authentifizierungsmethode verwendet wird. Die Teile 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:

Schritt 1: Einstellungen

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

  ( ) - _

• Umgebung: Verwenden Sie das Menü, um die Umfeld auszuwählen, in der die API gespeichert wird. 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 in Camel Case konvertierten API Namen ausgefüllt. Dieses Feld erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als Unterstriche (_) wird nicht empfohlen. Diese Sonderzeichen sind erlaubt:

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

• Version: Geben Sie eine optionale Version ein, die als Teil der Service URL der API verwendet werden soll. Dieses Feld erlaubt maximal 48 Zeichen und keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als eines Punktes (.) oder ein Bindestrich (-) wird nicht empfohlen. Gängige Namenskonventionen umfassen inkrementelle Versionen, wie z. B. v1.0, v1.1, v1.2 oder 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, bevor die API abläuft. Der Standardwert beträgt 30 Sekunden. Das Maximum beträgt 180 Sekunden.

  Notiz

  Diese Einstellung ist unabhängig von der Einstellung für das Operation Timeout in Integration Studio oder Design Studio. Einstellungen für das Timeout von Vorgängen werden nur dann 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 ausgewählt ist, werden die über API -Anfragen und-Antworten übermittelten Daten nicht verschlüsselt und können von anderen abgefangen und eingesehen werden. Dadurch könnten möglicherweise vertrauliche Informationen preisgegeben werden.

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

  Warnung

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

• Ausführliches Protokollieren aktivieren: Wählen Sie diese Option aus, um das ausführliche Protokollieren zu aktivieren. Das ausführliche Protokollieren für APIs umfasst Anforderungs- und Antwortdaten in jedem API -Protokoll, um eingehende und ausgehende Daten zu überwachen und das Debuggen zu erleichtern. Da dadurch große Protokolldateien erstellt werden 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 maximale Aktivierungsdauer beträgt zwei Wochen. Der Debug-Modus ermöglicht die vollständige Ablaufverfolgung für jede Anfrage, die über die Service-URL der API empfangen wird. Wenn diese Option aktiviert ist, behält das System den vollständigen Inhalt jeder API -Anfrage und-Antwort bis zu 24 Stunden ab dem Zeitpunkt des Empfangs des API Aufrufs bei und gilt für alle von der API ausgelösten Vorgänge.

  Notiz

  Das Durchsuchen der Ereignisdaten kann bei großen Mengen schwierig werden (Lasttests, Vorproduktionstests usw.). Die Zunahme der gespeicherten Daten kann zu Speicherplatz- und Sicherheitsproblemen führen. Wir empfehlen, den debuggen 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

• 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 eine Design Studio API Operation enthalten in der Umfeld, in der die API konfiguriert wird.

  • Operation: Wählen Sie aus den 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:

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

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

  • Methode: Wählen Sie eine von GET, PUT, POST, DELETE, PATCH, MERGE, oder ALL die Methode, die für die ausgewählte Operation erstellt werden soll. Auswahl ALL erstellt separate GET, PUT, POST, DELETE, PATCH, Und MERGE Methoden für die ausgewählte Operation.

• Entität zuweisen: Sobald alle Dropdown-Listen ausgefüllt sind, klicken Sie auf Entität zuweisen, um die Entität zur Tabelle unten hinzuzufügen. Es muss mindestens eine Entität 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: In einer Tabelle werden alle zugewiesenen Entitäten angezeigt. 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 zu Schritt 4: Zusammenfassung und Bestätigung zu navigieren.

Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen

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

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

  • Meine APIs
  • Portal Manager, einschließlich der Erstellung von API Dokumentation
  • Portal
  • API Protokolle
  • Analyse

  Zugriff auf die Sicherheitsprofile-Seite und der Zugriff auf die API sind von dieser Auswahl nicht betroffen. (Der Zugriff auf eine API wird durch Sicherheitsprofile gesteuert.)

  Alle definierten 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 aus diesem Grund nicht gelöscht werden.)

  Notiz

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

• Sicherheitsprofil(e) zuweisen: Verwenden Sie das Dropdown-Menü, um ein vorhandenes Sicherheitsprofil auszuwählen, das verwendet wird, um den Zugriff für die Nutzung der API einzuschränken. Sie können einen beliebigen Teil des Sicherheitsprofilnamens in das Menü eingeben, um die Liste der Sicherheitsprofile zu filtern. Die Menüergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert. Je nach Richtlinien der Harmony-Organisation muss möglicherweise ein Sicherheitsprofil zugewiesen werden, 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 aufgelistet, wie sie für das Sicherheitsprofil in Sicherheitsprofilkonfiguration konfiguriert wurden. Wenn der Typ Basic ist, zeigt die Spalte Benutzername den Benutzernamen an, der während der Konfiguration angegeben wurde. Wenn der Typ ein anderer Typ ist, zeigt die Spalte Benutzername denselben Wert wie der Typ an. 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: Wenn aktiviert, klicken Sie, 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, falls vorhanden, 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

• API Name und Umgebung: Der API Name gefolgt von der in Klammern eingeschlossenen Umfeld, 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 ist dieselbe wie die in Schritt 1: Einstellungen beschriebene. Sie können diese Einstellung direkt in diesem Schritt ändern, anstatt 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 initiiert einen Download einer APK-Datei (apis-export.apk), das einen Export der API enthält (siehe APIs exportieren und importieren).

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

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

  Notiz

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

• Als Entwurf speichern: Speichert die API im Status Entwurf oder Veröffentlicht mit Entwurf:

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

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

• Speichern und 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 wird auf Ihr API-URL-Abonnementlimit angerechnet, da die API zugänglich ist. Ein Dialog zeigt an, dass die API live ist:

  

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