Exportieren und Importieren von APIs im Jitterbit API Manager

Einführung

Von der APIs Seite aus können Sie APIs exportieren oder importieren, um sie nach Bedarf in andere Umgebungen oder Organisationen zu migrieren. Sie können mit einer einzelnen benutzerdefinierten API, OData-API oder Proxy-API oder mit einer Gruppe von APIs arbeiten.

APIs exportieren

Sie können APIs einzeln oder in Gruppen exportieren, um sie in andere Umgebungen oder Organisationen zu migrieren.

Eine einzelne API exportieren

Wählen Sie die Exportmethode basierend auf Ihrer aktuellen Ansicht:

• Listenansicht: Bewegen Sie den Mauszeiger über die Aktionen-Spalte der API und klicken Sie auf Exportieren.
• Kachelansicht: Klicken Sie auf das Aktionsmenü und wählen Sie Exportieren.

Durch die Auswahl von Exportieren wird die API in einer Datei mit dem Namen apis-export.apk heruntergeladen.

Mehrere APIs exportieren

Um mehrere APIs zu exportieren, klicken Sie auf Exportieren von der APIs Seite, um den Konfigurationsbildschirm zu öffnen.

Konfigurieren Sie die folgenden Einstellungen, um eine Gruppe von APIs zu exportieren:

• Umgebung auswählen: Verwenden Sie das Menü, um die Umgebung der zu exportierenden APIs auszuwählen. 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.

• APIs auswählen: Nachdem Sie eine Umgebung ausgewählt haben, wird eine Liste aller APIs innerhalb dieser Umgebung angezeigt.

  • Auswählen: Wählen Sie die zu exportierenden APIs aus. Verwenden Sie das Kontrollkästchen in der Kopfzeile, um alle APIs auf einmal hinzuzufügen.

  • API: Zeigt den Namen der API an. Die Farbe des Symbols links vom API-Namen zeigt die Kategorie des API-Status an:

    Symbol	Farbe	Kategorie
    	Grün	Die API ist veröffentlicht.
    	Gelb	Die API ist mit einem Entwurf veröffentlicht.
    	Offenes Grün	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 (benutzerdefiniert, OData oder Proxy).

• Export: Klicken Sie, um den Download der ausgewählten APIs in eine APK-Datei mit dem Namen apis-export.apk zu starten. Ein Dialog zeigt an, ob der Export erfolgreich war und listet die erfolgreich exportierten APIs auf.

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

APIs importieren

Um APIs zu importieren, klicken Sie auf Importieren auf der APIs-Seite.

Schritt 1: APIs auswählen und konfigurieren

In diesem Schritt wählen Sie die APK-Datei aus, wählen die Zielumgebung aus und konfigurieren die zu importierenden APIs.

• API-Datei: Klicken Sie auf Durchsuchen, um eine APK-Datei auszuwählen, die Sie zuvor aus dem API-Manager exportiert haben.

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

APIs zum Importieren auswählen und konfigurieren

Nachdem Sie eine APK-Datei ausgewählt haben, wählen Sie die APIs aus, die in die ausgewählte Umgebung importiert werden sollen.

• Auswählen: Wählen Sie die APIs zum Importieren aus. Verwenden Sie das Kontrollkästchen in der Kopfzeile, um alle APIs auf einmal auszuwählen.

• API: Zeigt den Namen der API an.

  Hinweis

  Ein Fehler-Icon erscheint neben dem API-Namen, wenn die Kombination aus Öffentlicher API-Name und Version bereits in der Zielumgebung vorhanden ist. Wenn Sie eine API mit einem Fehler zum Importieren auswählen, ist die Schaltfläche Weiter deaktiviert. Um den Fehler zu beheben, bearbeiten Sie einen oder beide dieser Werte in den zusätzlichen Einstellungen (siehe unten).

• API-Öffentlicher Name: Zeigt die Service-Root der API-Dienst-URL an.

• Version: Zeigt die Version der API an.

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

Zusätzliche Einstellungen konfigurieren

Klicken Sie auf den Pfeil , um zusätzliche Einstellungen für jede API anzuzeigen und zu konfigurieren.

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

• API-Öffentlicher Name: Zeigt die aktuelle Service-Root der API-Dienst-URL an. Verwenden Sie das Textfeld, um die Service-Root zu ändern, die für die API verwendet werden soll. Die folgenden Sonderzeichen sind erlaubt: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

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

• Sicherheitsprofil zuweisen: Optional können Sie das Menü verwenden, um ein vorhandenes Sicherheitsprofil auszuwählen, das verwendet wird, um den Zugriff auf die API zu beschränken. Sie können einen Teil des Namens des Sicherheitsprofils in das Menü eingeben, um die Liste der Sicherheitsprofile zu filtern. Die Menüergebnisse werden in Echtzeit mit jedem Tastendruck gefiltert. Wenn kein Sicherheitsprofil ausgewählt ist, wird die anonyme Authentifizierung verwendet. Je nach den Richtlinien der Harmony-Organisation müssen Sie möglicherweise ein Sicherheitsprofil zuweisen, um die API zu speichern.

  Hinweis

  Beim Importieren einer API können Sie nur ein einzelnes Sicherheitsprofil dieser API zuweisen. Nachdem Sie die API importiert haben, können Sie die API bearbeiten, um zusätzliche Sicherheitsprofile zuzuweisen.

  • Neues Profil erstellen: Klicken Sie, um den Bildschirm zur Konfiguration des Sicherheitsprofils zu öffnen. Nachdem Sie das neue Profil erstellt haben, steht es im Menü Sicherheitsprofil zuweisen zur Verfügung.

• Next: Nachdem Sie eine API zum Importieren ausgewählt haben, klicken Sie auf die nächste Schaltfläche, um zum nächsten Bildschirm zu gelangen.

• Cancel: Klicken Sie, um zur APIs Seite zurückzukehren.

• Import: Diese Schaltfläche ist deaktiviert, bis Sie Schritt 2 abgeschlossen haben.

Schritt 2: Wählen Sie APIs zum Veröffentlichen aus

In diesem Schritt wählen Sie aus, welche APIs sofort veröffentlicht werden sollen, und überprüfen die Anzahl der URLs, die nach Abschluss des Imports verwendet werden.

• Select: Wählen Sie optional die APIs aus, die beim Import veröffentlicht werden sollen. Der API-Manager speichert nicht ausgewählte APIs als Entwurfs-APIs. Verwenden Sie das Kontrollkästchen in der Kopfzeile, um alle APIs auf einmal auszuwählen. Während Sie APIs auswählen, werden die Werte unter URLs verwendet entsprechend aktualisiert.

• API-Öffentlicher Name: Zeigt den Namen der API an.

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

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

• URLs verwendet: Zeigt die Anzahl der veröffentlichten API-URLs an, die nach Abschluss des Imports gegen Ihr Harmony-Abonnement angerechnet werden.

• API: Spiegelt die Anzahl der API-URLs wider, die verwendet werden (nach Abschluss des Imports) von der Gesamtzahl der API-URLs, die durch das Abonnement der Organisation erlaubt sind. Derzeit verwendete API-URLs bestehen aus denen, die von veröffentlichten benutzerdefinierten und OData-APIs sowie deren veröffentlichten Klonen verwendet werden. Entwurfs-APIs zählen nicht als verwendete API-URLs.

• Proxy: Spiegelt die Anzahl der Proxy-API-URLs wider, die verwendet werden (nach Abschluss des Imports) von der Gesamtzahl der Proxy-API-URLs, die durch das Abonnement der Organisation erlaubt sind. Derzeit verwendete Proxy-API-URLs bestehen aus denen, die von veröffentlichten Proxy-APIs und deren veröffentlichten Klonen verwendet werden. Entwurfs-APIs zählen nicht als verwendete Proxy-API-URLs.

• Back: Klicken Sie auf die Zurück-Schaltfläche, um zu Schritt 1 zurückzukehren.

• Abbrechen: Klicken Sie, um zur API-Seite zurückzukehren.

• Importieren: Klicken Sie, um die ausgewählten APIs zu importieren. Die unterstützenden Projekte, Operationen und Entitäten müssen in der Zielumgebung vorhanden sein, damit die APIs ordnungsgemäß funktionieren.

  Wenn Sie auf Importieren klicken, wird eine Nachricht angezeigt, die angibt, ob die APIs erfolgreich importiert wurden. Bei Erfolg veröffentlicht der API-Manager die ausgewählten APIs in der neuen Umgebung, wodurch sie sofort zugänglich sind. Der API-Manager speichert APIs, die Sie nicht zur Veröffentlichung ausgewählt haben, als Entwürfe in der neuen Umgebung. Diese Entwurf-APIs sind in der neuen Umgebung nicht zugänglich, bis Sie sie einzeln veröffentlichen.

• Schließen: Klicken Sie, um zur API-Seite zurückzukehren.