Contact Free trial Login

Getting Started with Managing an API

You can use API Manager to apply policies and to add contracts, alerts, and SLA tiers to your API instance. Additionally, you can configure a proxy for your API that runs in CloudHub. Although you can also deploy your API proxy using Mule runtime engine (Mule) and Hybrid, deploying your API proxy directly to CloudHub is the fastest and easiest.

You can manage your API using the following steps:

Create an API Asset in Exchange

Before you can manage an API in API Manager, you must first create the asset in Anypoint Exchange:

  1. Log in to Anypoint Platform and select Anypoint Exchange.

  2. Click New Asset.

    getting started proxy new asset button
  3. In the Publish New Asset view, choose the asset type and an asset name.

    For RAML, OAS, or WSDL asset types, you must also provide the corresponding associated file.

    getting started proxy new asset view
  4. Click Publish.

Import Your API Asset to API Manager

After you create the API asset in Exchange, you import it to API Manager for further configuration:

  1. Log in to Anypoint Platform and select API Manager.

    The API Administration window is displayed.

  2. Select Manage API > Manage API from Exchange and in the Manage API from Exchange window, specify the following details:

    • API Name: Type the first characters of the API name that you created in Exchange.

      The list displays the full name of the API asset that you created in the previous procedure.

    • Asset Type: For this example, use HTTP, but you can also choose to create a RAML/OAS or WSDL API.

    • API Version: Available versions in Exchange.

    • Managing Type: To deploy an API with proxy on CloudHUb, select endpoint with proxy.

      If you do not want to configure your API with proxy, select Basic endpoint.

    • Mule version: If you are managing an API for Mule 4 or later, select this checkbox.

      In this example, create the API for Mule 4.

    • Implementation URI: Enter the URL for where the API implementation resides.

      For this example, use http://my-implementation.company.com:

      editing-api

      For additional configuration options, click Advanced options, and complete the details.

  3. Click Save.

The API settings view is displayed with the details of the imported API. Your API instance is now created:

created-api-in-admin-dashboard

Configure a Proxy and Deploy to CloudHub

Deploying an API proxy to CloudHub is the fastest way to protect your API, without having to worry about the infrastructure details, such as firewalls and so on.

To configure and deploy the proxy to CloudHub:

  1. In API Manager > [API Details] > Settings >, scroll down and verify that your Proxy deployment target field is set to CloudHub.

  2. Scroll down to Deployment Configuration:

    getting started proxy deployment config
  3. In Runtime Version, select the runtime version you need and specify a name for your application in the Proxy application name field.

  4. Click Deploy.

The following message is displayed:

getting started proxy success deployment

Your API proxy is now successfully running in CloudHub.

Configure a Proxy and Deploy to Anypoint Runtime Fabric

To configure and deploy a proxy to Runtime Fabric:

  1. In API Manager > [API Details] > Settings >, scroll down and verify that your Proxy deployment target field is set to Runtime Fabric.

  2. Scroll down to Deployment Configuration.

  3. In Runtime Version, select the runtime version you need and specify a name for your application in the Proxy application name field.

  4. Click Deploy.

Your API proxy is now successfully running in Runtime Fabric.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub