Contact Free trial Login

Creating an API Instance by Importing From Exchange

To manage the API that you created using Design Center or any another application, you must first import it to Anypoint Exchange (Exchange). You can then import the API to API Manager, from which you can modify the API version, status, and other information. After saving your changes, deploy the API to CloudHUb or any other runtime.

Before you you perform this procedure, ensure that you have the access permissions to an API in your organization’s Exchange.

To create an API instance by importing from Exchange:

  1. In API Manager, select Manage API > Manage API From Exchange.

    environment
  2. In API Name, type the first few characters of the API name and click the search icon.

  3. Select the API that you want to manage from the list of available APIs in Exchange.

    The Asset type, API version, and Asset version fields are automatically populated.

    OpenAPI Specification (OAS) 3.0 is currently not supported in API Manager. You must convert the API to RAML or OAS 2.0 to manage it using API Manager. For converting the specifications to OAS 2.0, you must use third-party tools, such as APImatic.
  4. In Managing Type, choose the type of API endpoint that you want to create:

    • Basic Endpoint

      Use this option if you created your API outside API Manager, but want to apply policies or otherwise manage the API using API Manager. For example, if you created the API using Mule Runtime, you do not need a proxy.

    • Endpoint with Proxy

      Use this option if you want to provide additional security for your API.

  5. Based on the type of endpoint you are creating, specify the application type for a basic endpoint or the proxy deployment target for an endpoint with proxy.

  6. If you want to manage the API using Mule 4 or later, select the Mule version checkbox. > In Implementation URI, replace the example by entering the URL of the site that hosts the API.

    For example, you can use the URL of your API asset in Exchange. In this case, the API is consuming the JSONPlaceholder API, so enter http://jsonplaceholder.typicode.com.

  7. If you are creating an endpoint with proxy, accept the default path / for the proxy endpoint in the Path field, or enter another path.

    For example, changing the path to /users makes the REST call to the service at the implementation URI http://jsonplaceholder.typicode.com/users.

  8. Optionally, expand the Advanced options section and specify additional details:

    • Specify the validations and an API instance label for the API.

    • If you are creating an endpoint with proxy, also specify a scheme (HTTP or HTTPS) and a port, or accept the defaults.

    • Specify a response timeout, if required.

    • If you choose Hybrid as the proxy deployment target, select the Reference user domain checkbox to use an API gateway domain.

      You must install the API gateway domain in Mule 3.8 and later.

  9. Click Save.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub