Exportieren und Importieren von APIs im Jitterbit API-Manager

Einführung

Über Meine APIs können Sie eine einzelne Custom API, einen OData Dienst oder eine Proxy-API oder eine Gruppe von APIs exportieren oder importieren:

• Exportieren: Ermöglicht Ihnen, eine einzelne API oder eine Gruppe von APIs in eine APK-Datei zu exportieren.
• Importieren: Ermöglicht Ihnen, eine einzelne API oder eine Gruppe von APIs mithilfe einer APK-Datei zu importieren, die zuvor im API-Manager exportiert wurde.

Zusammen ermöglichen Ihnen die Export- und Importfunktionen, APIs nach Bedarf in andere Umgebungen oder Organisationen zu migrieren.

APIs exportieren

Beim Exportieren von APIs können Sie eine einzelne API exportieren oder eine Gruppe von APIs.

Exportieren einer einzelnen API

Sie können eine einzelne Custom API, einen OData Dienst oder eine Proxy-API von diesen Speicherorten exportieren:

• In der Fliese auf Meine APIs Seite, bewegen Sie den Mauszeiger über die API Fliese und klicken Sie auf das Aktionsmenü und wählen Sie Exportieren:

  

• In der Listenansicht unter Meine APIs zeigen Sie auf die API Zeile, klicken Sie auf das Aktionsmenü in der Spalte Aktionen und wählen Sie Exportieren:

  

• Klicken Sie während der API Konfiguration unten in Schritt 4 auf Exportieren:

  

Wenn Sie Exportieren auswählen, wird der Download der API in eine Datei mit dem Namen gestartet apis-export.apk.

Exportieren einer Gruppe von APIs

Um eine Gruppe von APIs zu exportieren, klicken Sie unter Meine APIs auf *API exportieren *Seite:

Nachdem Sie auf API exportieren geklickt haben, wird der Bildschirm API exportieren geöffnet:

• Umgebung auswählen: Wählen Sie über das Menü die Umfeld der zu exportierenden APIs. 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.

• APIs auswählen: Sobald eine Umfeld ausgewählt wurde, wird eine Liste aller APIs innerhalb dieser Umfeld gefüllt:

  • Auswählen: Wählen Sie die zu exportierenden APIs aus. Über die Checkbox in der Header können alle APIs auf einmal hinzugefügt werden.

  • API: Zeigt den Namen der API an. Die Farbe des Symbols links neben dem API -Namen gibt die Kategorie des API -Status an:

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

  • Version: Zeigt die Version der API an, wie sie während der API Konfiguration eingegeben wurde.

  • API Typ: Zeigt den Typ der API an, entweder benutzerdefiniert (CUSTOM API), OData (ODATA) oder Proxy (API PROXY).

• Exportieren: Klicken Sie hier, um den Download der ausgewählten APIs in eine Datei mit dem Namen zu starten apis-export.apk Ein Dialogfeld zeigt an, ob der Export erfolgreich war, und zeigt eine Liste der erfolgreich exportierten APIs an:

  

• Abbrechen: Klicken Sie hier, um den Export abzubrechen und zu Meine APIs zurückzukehren Seite.

APIs importieren

Beim Importieren von APIs können Sie eine oder mehrere APIs aus einer zuvor exportierten APK-Datei zum Importieren in eine andere Umfeld.

Um APIs zu importieren, klicken Sie unter Meine APIs auf *API importieren *Seite:

Nachdem Sie auf API importieren geklickt haben, befolgen Sie diese Schritte, um APIs zu importieren:

• Schritt 1: APIs und Umfeld auswählen

• Schritt 2: Zu veröffentlichende APIs auswählen

Schritt 1: APIs und Umfeld auswählen

• API Datei: Klicken Sie auf Durchsuchen, um zu einer APK-Datei zu navigieren, die zuvor aus dem API-Manager exportiert wurde.

• Umgebung: Wählen Sie über das Menü die Umfeld, in die Sie die APIs importieren möchten. 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.

• Zu importierende API(s) auswählen: Wählen Sie die APIs aus, die in die ausgewählte Umfeld importiert werden sollen.

  • Auswählen: Wählen Sie die zu importierenden APIs aus. Über die Checkbox in der Header können alle APIs auf einmal ausgewählt werden.

  • API: Der Name der API.

    Hinweis

    Ein Ein Fehlersymbol wird neben dem Namen der API angezeigt, wenn die Kombination aus Öffentlicher API -Name und Version bereits in der Umfeld vorhanden ist. Wenn eine API mit einem Fehler zum Importieren ausgewählt wird, ist die Schaltfläche Weiter deaktiviert. Um das Problem zu beheben, bearbeiten Sie einen oder beide dieser Werte in den zusätzlichen Einstellungen (unten beschrieben).

  • Öffentlicher API Name: Die Service-Root der API Service-URL.

  • Version: Die Version der API.

  • Typ: Der API-Typ, einer von benutzerdefiniert (CUSTOM API), OData (ODATA) oder Proxy (API PROXY).

  • Zusätzliche Einstellungen: Klicken Sie auf das Dreiecksymbol , um zusätzliche Einstellungen für die API anzuzeigen:

    

    • API Name: Zeigt den aktuellen Namen der API an. Verwenden Sie das Textfeld, um den Namen der API zu ändern.

    • Öffentlicher API Name: Zeigt den aktuellen Service Root der API Service-URL an. Verwenden Sie das Textfeld, um den Service Root zu ändern, der für die API verwendet werden soll. Diese Sonderzeichen sind zulässig:

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

    • Version: Zeigt die aktuelle Version der API an. Verwenden Sie das Textfeld, um die für die API zu verwendende Version zu ändern.

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

      Diese Einstellung bestimmt den Zugriff auf diese bestimmte 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 kann die Rolle Administrator aus diesem Grund nicht gelöscht werden.)

    • Sicherheitsprofil zuweisen: Verwenden Sie optional das 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. Wenn kein Sicherheitsprofil ausgewählt ist, wird eine anonyme Authentifizierung verwendet. Je nach den Richtlinien der Harmony-Organisation muss möglicherweise ein Sicherheitsprofil zugewiesen werden, um die API zu speichern.

      Notiz

      Beim Importieren einer API kann dieser API nur ein einziges Sicherheitsprofil zugewiesen werden. Sobald die API importiert ist, können Sie die API bearbeiten, um zusätzliche Sicherheitsprofile zuzuweisen.

      • Neues Profil erstellen: Klicken Sie hier, um den Konfigurationsbildschirm für Sicherheitsprofil zu öffnen. Sobald das neue Profil erstellt wurde, steht es zur Auswahl im Menü Sicherheitsprofil zuweisen.

• Weiter: Sobald eine API zum Importieren ausgewählt ist, klicken Sie auf das Klicken Sie auf die Schaltfläche „Weiter“, um zum nächsten Bildschirm zu gelangen.

• Abbrechen: Klicken Sie hier, um zu Meine APIs zurückzukehren Seite.

• Importieren: Diese Schaltfläche ist deaktiviert, bis Schritt 2: Zu veröffentlichende APIs auswählen ist abgeschlossen.

Schritt 2: Zu veröffentlichende APIs auswählen

• API Datei: Dieses Feld ist in diesem Schritt der Konfiguration deaktiviert. Um Änderungen vorzunehmen, kehren Sie zu Schritt 1 zurück der Konfiguration.

• Umgebung: Dieses Feld ist in diesem Schritt der Konfiguration deaktiviert. Um Änderungen vorzunehmen, kehren Sie zu Schritt 1 zurück der Konfiguration.

• Zu veröffentlichende APIs auswählen: Die zuvor zum Import ausgewählten APIs werden angezeigt:

  • Auswählen: Wählen Sie optional die APIs aus, die beim Import veröffentlicht werden sollen. Nicht ausgewählte APIs werden als APIs Entwürfe gespeichert. Mit dem Kontrollkästchen in der Header können alle APIs auf einmal ausgewählt werden. Wenn APIs ausgewählt werden, werden die Werte unter Verwendete URLs entsprechend aktualisiert.

  • Öffentlicher API Name: Der Name der API.

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

  • Typ: Der API-Typ, einer von benutzerdefiniert (CUSTOM API), OData (ODATA) oder Proxy (API PROXY).

• Verwendete URLs: Die Anzahl der veröffentlichten API URLs, die nach Abschluss des Imports auf Ihr Harmony Abonnementkontingent angerechnet werden.

  • API: Gibt die Anzahl der API URLs an, die (nach Abschluss des Imports) im Verhältnis zur Gesamtzahl der API URLs verwendet werden, die durch das Abonnement der Organisation zugelassen sind. Derzeit verwendete API URLs bestehen aus den von veröffentlichten benutzerdefinierten und OData Service APIs und deren veröffentlichten Klonen verwendeten URLs. APIs Entwürfe zählen nicht als verwendete API URLs.

  • Proxy: Gibt die Anzahl der Proxy API URLs an, die (nach Abschluss des Imports) im Einsatz sein werden, im Verhältnis zur Gesamtzahl der Proxy API URLs, die durch das Abonnement der Organisation zugelassen sind. Derzeit verwendete Proxy-API URLs bestehen aus den von veröffentlichten Proxy-APIs und ihren veröffentlichten Klonen verwendeten URLs. APIs Entwürfe zählen nicht als im Einsatz befindliche Proxy API URLs.

• Zurück: Klicken Sie auf das Zurück-Taste, um zu Schritt 1 zurückzukehren der Konfiguration.

• Abbrechen: Klicken Sie hier, um zu Meine APIs zurückzukehren Seite.

• Importieren: Klicken Sie hier, um die APIs zu importieren.

Wenn Sie auf Importieren klicken, wird eine Meldung angezeigt, dass die APIs erfolgreich importiert wurden:

Wenn die zugehörigen Projekte, Vorgänge und Entitäten in der Umfeld fehlen, wird eine Fehlermeldung angezeigt:

• Verwerfen: Klicken Sie hier, um zu Meine APIs zurückzukehren Seite.