Skip to end of metadata
Go to start of metadata

Introduction

From the My APIs page, you can export or import a single Custom API, OData Service, or Proxy API, or a group of APIs:

  • Export: Allows you to export a single API or a group of APIs to an APK file.
  • Import: Allows you to import a single API or a group of APIs using an APK file that was previously exported in API Manager.

Together, the export and import functionalities allow you to migrate APIs into other environments or organizations as needed. 

NOTE: The supporting projects, operations, and entities must exist in the destination environment for the APIs to function properly.

Exporting APIs

When exporting APIs, you can export a single API or a group of APIs.

Exporting a Single API

You can export a single Custom API, OData Service, or Proxy API from these locations:

  • In card view on the My APIs page, hover over the API card, click the actions menu icon and select Export:

  • In list view on the My APIs page, hover over the API row, click the actions menu icon  in the Actions column, and select Export:

  • During API configuration, click Export at the bottom of step 4:

Selecting Export initiates a download of the API to a file named apis-export.apk.

Exporting a Group of APIs

To export a group of APIs, click Export API from the My APIs page:

After clicking Export API, the Export API screen opens:

  • Select Environment: Using the dropdown, select the environment of the APIs to be exported.
  • Select API(s): Once an environment has been selected, a list of all APIs within that environment is populated:

    • Select: Select the APIs to export. The checkbox in the header column can be used to add all APIs at once.
    • API: Displays the name of the API. The color of the icon to the left of the API name indicates the category of the API status:

      IconColorCategory

      GreenThe API is published.

      YellowThe API is published with a draft.

      Open GreenThe API is a draft.
    • Version: Displays the version of the API, as entered during API configuration.
    • API Type: Displays the type of API, either Custom (CUSTOM_API), OData (ODATA), or Proxy (API_PROXY).
  • Export: Click to initiate a download of the selected API(s) to a file named apis-export.apk. A dialog indicates if the export was successful and displays a list of the APIs successfully exported:

  • Cancel: Click to cancel the export and return to the My APIs page.

Importing APIs

When importing APIs, you can select one or more APIs from a previously exported APK file to be imported into another environment. 

WARNING: By default, the imported APIs are anonymous until a security profile within the import environment is assigned to the API.

To import APIs, click Import API from the My APIs page:

After clicking Import API, follow these steps to import API(s):

Step 1: Select API(s) and Environment

  • Select APK File: Click Browse to browse to an APK file that has been previously exported from API Manager.
  • Environment: Use the dropdown to select the environment you want to import the API(s) into. 
  • Next: Click to display the list of APIs available within the selected APK file.
  • Cancel: Click to return to the My APIs page.

A list of APIs available in the selected file are displayed:

  • Select API(s): Select the API(s) to be imported into the previously selected environment
    • Select: Select the APIs to import. The checkbox in the header column can be used to add all APIs at once.
    • API: The name of the API.
    • Version: The version of the API, as entered during API configuration.
  • Next: Click to move to the next screen.
  • Cancel: Click to return to the My APIs page.

Step 2: Select API(s) to Be Published

  • URLs Used: The number of published API URLs counted against your Jitterbit Harmony subscription allowance.
    • API: The number of currently used API URLs out of the total number of API URLs allowed by the organization's subscription. Currently used API URLs consist of those used by published Custom and OData Service APIs and their published clones. Draft APIs do not count as in-use API URLs.
    • Proxy: The number of currently used Proxy API URLs out of the total number of Proxy API URLs allowed by the organization's subscription. Currently used Proxy API URLs consist of those used by published Proxy APIs and their published clones. Draft APIs do not count as in-use API URLs.
  • Select API(s) to Publish: The APIs selected to be imported are displayed:
    • Select: Select the APIs to be published when imported. Unselected APIs are saved as draft APIs. The checkbox in the header column can be used to add all APIs at once.
    • API: The name of the API.
    • Version: The version of the API, as entered during API configuration.
    • API Type: The type of API, either Custom (CUSTOM_API), OData (ODATA), or Proxy (API_PROXY).
  • Import: Click to import the API(s).
  • Cancel: Click to return to the My APIs page.
NOTE: The supporting projects, operations, and entities must exist in the destination environment for the APIs to function properly.

On clicking Import, a message indicates the API(s) were successfully imported:

NOTE:  The selected APIs are published in the new environment and are immediately accessible. The APIs that were not selected to publish are saved in the new environment as drafts. The draft APIs are not accessible in the new environment until they are individually published.

If the associated projects, operations, and entities are missing from the destination environment, an error message will appear:

  • Dismiss: Click to return to the My APIs page.

  • No labels