Skip to main content
Feedback

Importing API from Boomi Platform

This feature lets you discover and import the Boomi Platform API Service in the Cloud API Management dashboard. You can import a new API Service from Platform to Cloud API Management or reimport an existing Platform API Service in Cloud API Management.

When you first import a Platform API Service, a new API definition is created in the Cloud API Management dashboard. If the API Service already exists in the Cloud API Management dashboard and you import it again, the existing Cloud API Management API definition is updated.

note

The Import API from Boomi Platform option on the Manage your APIs with API Definitions page is only available to Platform-enabled accounts (or Platform users) when the feature flag is enabled for your area in Cloud API Management.

If this option is not visible, the feature is likely disabled for your area, or you are not a Platform user. To enable it, contact the Boomi Account Representative. Once enabled, the feature flag cannot be disabled.

important

In addition to the Cloud API Management Administrator role, you also require these Platform privileges: API Management and Environment Management to import an API from the Platform to Cloud API Management. Refer to API Management Roles and Privileges for more information.

Procedure

  1. Navigate to New API Definition > Import from Boomi Platform. The Import from Boomi Platform wizard opens, displaying all the APIs deployed on the Platform.

    important

    About Boomi Session Expiration
    When importing an API Service from Platform to Cloud API Management, the Boomi session expires after 4-5 minutes of inactivity, requiring you to close the Import from Boomi Platform wizard and relaunch Cloud API Management via Boomi Platform.

  2. Import a new API or an existing API.

    1. If importing a new API, follow the steps below:

      1. On the wizard's first screen, select an API that has no existing version assigned by clicking the radio button next to the row or by selecting the entire row.
        Image

        tip

        The columns on the wizard are resizable. You can drag and drop the columns or resize them if you cannot view the text of a specific column. You can also sort the columns in ascending or descending order.

        note

        1. You can import only one API at a time. Only REST APIs can be imported from the Platform. GraphQL, SOAP, JSON-RPC, XML-RPC, and other endpoint types are not supported.

        2. You cannot import an API if its Existing Version and Latest Version are the same. Identical versions indicate that the Platform API Service was already imported into Cloud API Management. To proceed, select an API whose existing and latest versions differ. However, reimporting is possible for the same API if a newer version is available.

      2. Optional: In the Search box, enter the text. The Search functionality performs a global search for the specified text (partial or complete match) across the available columns.

      3. Optional: Click the Filters icon. This opens the Filter pop-up window.

        1. In Environment, select a Platform environment from the list. This filters the API for the selected environment.
        2. In Gateway Authentication, select the type of gateway authentication.
          note

          Currently, only gateway-configured APIs can be imported from the Platform to Cloud API Management.

        3. Click Apply to set the filter values, or click Reset to reset them.

      4. Click Next to go to the next screen.

      5. On the wizard's second screen, select an Organization and Public Endpoint Domain from the list.

        1. In the Select Endpoints section:

          1. Next to the Endpoint Name column, select either the checkbox or the entire row to choose an endpoint. By default, the individual methods checkboxes get selected.

          2. Select or deselect individual method checkboxes (GET, POST, PUT, PATCH, or DELETE) for the chosen endpoint.

      6. Click Import as New API.

    2. If importing an existing API, follow the steps below:

      1. On the wizard's first screen, select an API whose existing and latest versions are different by clicking the radio button next to the row, or select the entire row.

        note

        You can reimport an API that has already been imported if its Existing Version and Latest Version are different. When reimporting an already imported API, it upgrades the latest version and resets the configuration. Ensure you review API endpoints before reimporting.

        Image

        1. Click Next to go to the next screen.

        2. On the wizard's second screen, in the Select Endpoints section:

          1. Next to the Endpoint Name column, select either the checkbox or the entire row to choose an endpoint. Here, only the previously selected allowed methods are selected by default, but you can also select additional methods.

          2. Select or deselect individual method checkboxes (GET, POST, PUT, PATCH, or DELETE) for the chosen endpoint.

            note

            By default, the Organization and Public Endpoint Domain field remains disabled during the reimport of an API that was previously imported.

        3. Click Import and upgrade existing API.

Next Steps

On successful API creation, the new API appears on the Manage your APIs with API Definitions (API Definitions list) page. Next, to view endpoint configuration details of your API:

  • On the Manage your APIs with API Definitions (API Definitions list) page, click the API link. This opens the Endpoints:<your imported api name> page. On this page, click the endpoint link. This opens the Methods: <your imported api name> page.

  • On the left side, navigate to various tabs (Domains and Traffic Routing, Key & Method Detection, etc.) to view configuration details of your API in each tab.

    We recommend not changing any settings in the Domains & Traffic Routing, Key & Method Detection, and Call Transformations tabs.

important

About Authorization Header
Any imported API Service from Platform to Cloud API Management must include an authorization header before the Traffic Manager (Cloud API Management gateway) calls the imported API.

You can view your API's authorization header details in the Call Transformations tab. On the Methods: your imported api name page, navigate to this tab to open the Endpoint Call Transformations: <your imported api name> page. The authorization header value appears in the Data to make available for pre-processing field. Since the Platform manages the authorization header, we recommend not changing this value.

On this Page