APIs-Seite im Jitterbit API-Manager

Einführung

Die Seite APIs ist die Zielseite des API-Manager und bietet Administratoren der Harmony-Organisation die Möglichkeit, benutzerdefinierte APIs zu verwalten, OData Dienste und Proxy APIs über API-Manager erstellt.

Mitglieder einer Rolle, denen Lesezugriff Umfeld gewährt wurde können auch auf die Seite APIs für APIs in dieser Umfeld zugreifen. Mitglieder einer Rolle, denen Schreibzugriff Umfeld gewährt wurde haben in dieser Umfeld Schreibzugriff.

Um auf die Seite APIs zuzugreifen, melden Sie sich beim Harmony-Portal an, und gehen Sie dann über das Harmony Portalmenü oben links zu API-Manager > APIs:

Stellen Sie sicher, dass Sie die gewünschte Organisation aufrufen. Diese kann in der oberen Navigationsleiste geändert werden (siehe Ändern der ausgewählten Organisation im Harmony-Portal).

Header der APIs-Seite

Die Header oben auf der Seite APIs enthält die folgenden Steuerelemente:

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

• Verwendete Custom API URLs: Die Anzahl der aktuell verwendeten benutzerdefinierten API URLs im Vergleich zur Gesamtzahl der benutzerdefinierten API URLs, die im Abonnement der Organisation zulässig sind. Zu den aktuell verwendeten API URLs zählen die von veröffentlichten benutzerdefinierten und OData APIs sowie deren veröffentlichten Klonen verwendeten URLs. Entwurfs APIs zählen nicht zu den verwendeten API URLs.

• Verwendete Proxy-API URLs: Die Anzahl der aktuell verwendeten Proxy-API URLs im Vergleich zur Gesamtzahl der im Abonnement der Organisation zulässigen Proxy API URLs. Zu den aktuell verwendeten Proxy-API URLs zählen die von veröffentlichten Proxy APIs und deren veröffentlichten Klonen verwendeten URLs. Entwurfs APIs zählen nicht zu den verwendeten API URLs.

• Filter: Öffnet einen Bereich mit Steuerelementen zum Filtern der Tabelle nach API -Typ, API Status, API Gruppe, Umgebung, Sicherheitsprofil und den Daten Zuletzt bearbeitet und Zuletzt veröffentlicht:

  

  Filter werden sofort angewendet. Mit den Schaltflächen Löschen oder Alle löschen können Sie die Filter zurücksetzen. Klicken Sie auf die Schaltfläche Schließen, um den Bereich zu schließen.

• Suchen: Geben Sie einen beliebigen Teil des API -Namens, der Version, der Umfeld, des Typs, der Beschreibung, des Status oder des Datums bzw. der Uhrzeit der letzten Veröffentlichung oder Bearbeitung der API in das Suchfeld ein, um die Liste der APIs zu filtern (nur alphanumerische Zeichen). Bei der Suche wird die Groß-/Kleinschreibung nicht berücksichtigt.

• Ansicht: Klicken Sie auf das Fliese-Ansicht oder Listenansicht, um das Anzeigeformat für APIs auf dieser Seite umzuschalten. Die Kachelansicht ist die anfängliche Standardansicht. Beim nächsten Laden der Seite „APIs“ ist die zuletzt ausgewählte Ansicht bereits ausgewählt.

• API importieren: Öffnet den API Importbildschirm, wo Sie APIs im APK-Format importieren können (siehe APIs exportieren und importieren).

• API exportieren: Öffnet den API Exportbildschirm, wo Sie ausgewählte APIs im APK-Format exportieren können (siehe APIs exportieren und importieren).

• Neu: Verwenden Sie das Menü, um den zu erstellenden API Typ auszuwählen, entweder Custom API oder Proxy-API:

  • Custom API: (Nur verfügbar, wenn eine benutzerdefinierte API URL verfügbar ist.) Öffnet den API Konfigurationsbildschirm, um eine neue benutzerdefinierte oder OData API.

  • *Proxy-API: *(Nur verfügbar, wenn eine Proxy-API URL verfügbar ist.) Öffnet den Proxy-API Konfigurationsbildschirm, um einen neuen Proxy zu erstellen API.

Kachelansicht

Um auf die Fliese zuzugreifen, wählen Sie das Symbol Kachel-Ansicht.

In der Kachelansicht werden APIs als Kacheln angezeigt. Jede Fliese hat eine Vorder- und eine Rückseite, die umgedreht werden können, um zusätzliche API Informationen und Aktionen anzuzeigen. Standardmäßig wird die Vorderseite angezeigt. Die Rückseite wird angezeigt, wenn Sie mit der Maus über die Fliese fahren:

• Vorderseite: Die Vorderseite der Fliese zeigt den API Namen, die Version, die Umfeld, den API Typ (Benutzerdefiniert, OData oder Proxy), den API Status (Veröffentlicht, Veröffentlicht mit Entwurf oder Entwurf) und das Datum der letzten Bearbeitung oder Veröffentlichung (in MM/DD/YY Format) in lokaler Browserzeit. Die Farbe des Symbols links neben dem API Status zeigt die Kategorie des API Status an:

  Symbol	Farbe	Kategorie
  	Grün	Die API ist veröffentlicht.
  	Gelb	Die API wird als Entwurf veröffentlicht.
  	Open Green	Die API ist ein Entwurf.

• Rückseite: Die Rückseite der Fliese (sichtbar, wenn Sie mit der Maus über eine Fliese fahren) zeigt den API Namen, die Umfeld, die API -Beschreibung und den Namen des Benutzers, der die API zuletzt bearbeitet hat. Darüber hinaus sind folgende Aktionen verfügbar:

  • Anzeigen/Bearbeiten: Öffnet den API -Konfigurationsbildschirm (siehe Custom API -Konfiguration, OData-Dienstkonfiguration oder Proxy-API Konfiguration).

  • Aktionen: Klicken Sie auf das Aktionsmenü, um ein Menü mit diesen Aktionen zu öffnen:

    API Menüpunkt	Beschreibung
    	API Protokolle öffnet die API Protokolle, auf der Verarbeitungs- und debuggen (sofern die debuggen aktiviert ist) für alle APIs angezeigt werden.
    	Analytics öffnet die Analytics-Seite, auf der Verbrauchs- und Leistungsmesswerte für alle APIs angezeigt werden.
    	Klon öffnet den API Konfigurationsbildschirm (siehe Custom API Konfiguration, OData-Dienstkonfiguration oder Proxy-API Konfiguration), vorab ausgefüllt mit den Konfigurationsdetails der geklonten API und aktualisierten Standardwerten für diese Felder: API Name: Dem API -Namen wird Kopie von vorangestellt. Dienststamm: Dem Dienststamm wird Kopie von vorangestellt. Version: Der Version wird -2 angehängt. Diese Zahl erhöht sich nicht mit zusätzlichen Klonen.
    	Export initiiert einen Download der API in eine Datei namens apis-export.apk. Diese Datei kann dann in eine andere Umfeld oder Organisation importiert werden (siehe Exportieren und Importieren von APIs).
    	Löschen löscht die API dauerhaft. Wenn Sie auf Löschen klicken, wird ein Bestätigungsdialogfeld angezeigt, in dem Sie bestätigen können, dass Sie die API dauerhaft löschen möchten. Achtung OpenAPI-Dokumentation wird auf dem Portal angezeigt wird nicht automatisch aktualisiert, wenn Sie eine API löschen. Um die OpenAPI-Dokumentation zu aktualisieren, verwenden Sie den Portal Manager Seite.

  • URL kopieren: Kopiert die API URL in Ihre Zwischenablage.

Listenansicht

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

Die Listenansicht zeigt APIs in einer Tabelle an. Jede Spalte wird unten beschrieben. Durch Klicken auf eine API Zeile wird die API Details geöffnet (siehe unten).

Die verfügbaren Spalten lauten wie folgt:

• API -Name: Der Name der API.

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

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

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

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

• Letzte Bearbeitung: Das letzte Speicherdatum (in MM/DD/YYYY Format), Zeit (im HH:MM:SS Format) und den Zeitraum (AM oder PM) in lokaler Browserzeit.

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

• Gruppe: Der Name aller API Gruppen, zu dem die API gehört.

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

• Letzte Veröffentlichung: Das Veröffentlichungsdatum (in MM/DD/YYYY Format), Zeit (im HH:MM:SS Format) und den Zeitraum (AM oder PM) in lokaler 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: Bewegen Sie den Mauszeiger über die API Zeile, um weitere Aktionen anzuzeigen:

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

  • API Basis URL kopieren: Klicken Sie hier, um die Basis URL der API in Ihre Zwischenablage zu kopieren.

  • Exportieren: Öffnet die Ordnerauswahl für Ihren lokalen Computer. Wählen Sie einen Ordner zum Speichern des API Exports aus. Weitere Informationen finden Sie unter Exportieren und Importieren von APIs.

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

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

    API Menüpunkt	Beschreibung
    Klonen	Öffnet den API -Konfigurationsbildschirm (siehe Custom API -Konfiguration, OData-Dienstkonfiguration oder Proxy-API Konfiguration), vorab ausgefüllt mit den Konfigurationsdetails der geklonten API und aktualisierten Standardwerten für diese Felder: API Name: Dem API -Namen wird Kopie von vorangestellt. Dienststamm: Dem Dienststamm wird Kopie von vorangestellt. Version: Der Version wird -2 angehängt. Diese Zahl erhöht sich nicht mit zusätzlichen Klonen.
    Löschen	Löscht die API dauerhaft. Wenn Sie auf Löschen klicken, wird ein Bestätigungsdialogfeld angezeigt, in dem Sie bestätigen können, dass Sie die API dauerhaft löschen möchten. Achtung OpenAPI-Dokumentation wird auf dem Portal angezeigt wird nicht automatisch aktualisiert, wenn Sie eine API löschen. Um die OpenAPI-Dokumentation zu aktualisieren, verwenden Sie den Portal Manager Seite.
    Auf Portal anzeigen	(Nur für benutzerdefinierte oder Proxy-APIs mit dem Status Veröffentlicht oder Veröffentlicht mit Entwurf aktiviert.) Öffnet das Portal Seite für die API.
    Protokolle anzeigen	Öffnet die API Protokolle, auf der Verarbeitungs- und debuggen (sofern die debuggen aktiviert ist) für alle APIs angezeigt werden.
    Analytics	Öffnet die Analytics-Seite, auf der Verbrauchs- und Leistungsmesswerte für alle APIs angezeigt werden.

API Detailschublade

Um die Details einer API anzuzeigen, wählen Sie in der Listenansicht eine API in der Tabelle aus. Unten im Fenster öffnet sich eine Schublade mit fünf Registerkarten: Profil, Einstellungen, Dienste, Sicherheitsprofile, Benutzerrollen (für benutzerdefinierte APIs und OData-Dienste) und Anforderungsheader (für Proxy APIs).

In der Header der Schublade werden die folgenden Details und Steuerelemente angezeigt:

• API -Name und-Version: Zeigt den Namen der API und ihre Version (falls zutreffend) an.
• Zurück / Weiter: Navigiert durch die APIs-Liste der Organisation.
• Erweitern: Erweitert die Schublade auf den Vollbildmodus. Klicken Sie nach dem Erweitern auf das Minimieren-Symbol, um zur vorherigen Ansicht zurückzukehren.
• Schließen Schließt die Schublade.

Tab „Profil“

Auf der Tab Profil werden allgemeine Informationen zur API angezeigt:

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

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

• Beschreibung: (Nur für benutzerdefinierte APIs und OData Dienste sichtbar.) Die Beschreibung der API, wie sie während der API -Konfiguration eingegeben wurde.

• Vorhandene API URL: (Nur für Proxy APIs sichtbar.) Die URL der API zum Proxy.

Tab „Einstellungen“

Die Tab Einstellungen bietet eine Übersicht über die API-Einstellungen (die während der API Konfiguration angegeben werden):

Notiz

Um eine dieser Einstellungen zu bearbeiten, müssen Sie in der Tabelle in der Spalte Aktion der API auf Bearbeiten klicken.

• Timeout: Die Anzahl der Sekunden, 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. 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 aktiviert (Standard), werden Daten über SSL verschlüsselt und HTTPS wird für alle API Anfragen und-Antworten erzwungen (empfohlen).

  Wenn diese Option deaktiviert 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: Wenn aktiviert, wird das Cross-Origin Resource Sharing (CORS)-Mechanismus wird verwendet (nicht empfohlen).

  Warnung

  CORS führt zu Operationen mit dem OPTIONS Methode zur Ausführung ohne Authentifizierung.

• Ausführliche Protokollierung aktivieren: Wenn diese Option aktiviert ist, umfasst die ausführliche Protokollierung für APIs Anforderungs- und Antwortdaten in jedem API Protokoll, um die Überwachung eingehender und ausgehender Daten zu unterstützen und das Debuggen zu erleichtern. Diese Einstellung ist standardmäßig deaktiviert, da sie große Protokolldateien erstellen kann.

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

Tab „Dienste“

Die Tab Dienste enthält eine Tabelle mit einer Übersicht der API Dienste:

Die Tabelle kann nach Dienstname, Methode, Pfad, Projekt, Auszulösender Vorgang oder Antworttyp sortiert werden, indem Sie auf die jeweilige Header klicken.

• Dienstname: Der Name des API Dienstes.

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

• Pfad: Der Pfad für die Anfrage.

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

• Auszulösende Operation: (Nur für benutzerdefinierte APIs und OData Dienste sichtbar.) Der Name der aufgerufenen Operation.

• Antworttyp: (Nur für benutzerdefinierte APIs und OData Dienste sichtbar.) Der Antworttyp, einer von Endziel, Systemvariable oder Keine Antwort.

• Aktionen: Bewegen Sie den Mauszeiger über die Servicezeile, um weitere Aktionen anzuzeigen:

  • API -Dienst URL kopieren: Kopiert die API Dienst URL in die Zwischenablage.

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

Tab „Sicherheitsprofile“

Die Tab Sicherheitsprofile enthält eine Liste aller Sicherheitsprofile wird verwendet, um den Zugriff für die Nutzung der API einzuschränken:

Die Tabelle kann nach Profilname, Typ oder Benutzername sortiert werden, indem Sie auf die jeweilige Header klicken.

• Profilname: Der Name des Sicherheitsprofils.

• Typ: Der Authentifizierungstyp, einer von Anonym, API Schlüssel, Basic oder OAuth 2.0.

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

• Aktionen: Bewegen Sie den Mauszeiger über die Zeile des Sicherheitsprofils, um eine zusätzliche Aktion anzuzeigen:

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

Tab „Benutzerrollen“

Die Tab Benutzerrollen enthält eine Liste der Organisationsrollen, deren Mitglieder Zugriff auf die API haben:

Notiz

Diese Tab ist nur für benutzerdefinierte APIs und OData-Dienste sichtbar.

Durch Klicken auf die jeweilige Header kann die Tabelle nach Benutzerrolle sortiert werden.

• Benutzerrolle: Der Name der Harmony Rolle.

• Aktionen: Bewegen Sie den Mauszeiger über die Zeile mit der Rolle, um eine zusätzliche Aktion anzuzeigen:

  • Gehe zu Rolle: Öffnet die Benutzerverwaltung Seite.

Tab „Anforderungsheader“

Die Tab Anforderungsheader enthält eine Liste der Anforderungsheader der Proxy-API:

Notiz

Diese Tab ist nur für Proxy-APIs sichtbar.

Durch Klicken auf die jeweilige Header kann die Tabelle nach Schlüssel oder Wert sortiert werden.

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

• Wert: Der Wert des Anforderungsheaders.

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

  Hinweis

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

Einstellungen der Listenansichtsseite

Sie können die Tabelle sortieren, die Spalten neu anordnen oder den Inhalt aktualisieren:

• Sortieren: Klicken Sie auf eine beliebige Spaltenüberschrift, um die Tabelle aufsteigend zu sortieren. Klicken Sie erneut, um die Sortierreihenfolge umzukehren.

• Spalten: Klicken Sie auf, um die Anordnung und Sichtbarkeit der Spalten zu ändern. Spalten filtern. Die Spalten-Schublade wird geöffnet:

  

  Die Schublade verfügt über folgende Bedienelemente:

  • Suchen: Geben Sie einen beliebigen Teil des Spaltennamens in das Suchfeld ein, um die Spaltenliste zu filtern (nur alphanumerische Zeichen). Die Suche berücksichtigt keine Groß- und Kleinschreibung.

  • Alle anzeigen: Alle Spalten sichtbar machen.

  • Verschieben: Durch Ziehen und Ablegen können Sie die Position der Spalte relativ zu anderen Spalten ändern.

  • Ausblenden: Die Spalte ist sichtbar. Klicken Sie hier, um sie auszublenden.

  • Anzeigen: Die Spalte ist ausgeblendet. Klicken Sie hier, um sie anzuzeigen.

  • Speichern: Speichert die Spalten.

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