Nav

API Manager

API Manager is a component of Anypoint Platform for registering, designing, building, managing, and publishing APIs.

About Anypoint Platform

Anypoint Platform uses Mule as its core runtime engine for managing APIs. You can use API Manager in the cloud or on premises, and for hybrid use cases. A hybrid deployment is an API deployed on a server but having metadata processed in the cloud.

Sign up to use Anypoint Platform, and then log into Anypoint Platform to access API Manager. On the Anypoint Platform web site, open API Manager.

index-56365

Alternatively, you can use the Anypoint Platform CLI to interact with API Manager.

API Manager Overview

After opening API Manager, the API Administration page appears. On this page, you can register an API. An API registered in API Manager belongs to a business group and can have multiple API versions. You can base the API definition on the RAML specification using the API Designer within API Manager. You can apply one or more policies, such as the Client ID Enforcement, to each API version. You configure an endpoint, and API Manager deploys an API implementation to a Mule Runtime that runs on a server, such as CloudHub. Each server belongs to an environment, such as Dev, Test, or Production, which you monitor using Runtime Manager. Servers are defined in business groups and each business group can have multiple environments. You publish your API on the portal and apps request access, as depicted in the following diagram.

index-6addf

The first step in using API Manager is to register an API. You can create or import an API in API Manager, or use the auto-discovery process to register and start a Mule app. In this case registration and start up occurs without user intervention. The API Administration page, shown in the next screenshot, appears when you click API Manager on the Anypoint Platform home page. The API Administration page is an administrative view of the APIs currently registered in the platform. From this view, API Creators and Organization Administrators can register new APIs or add new versions to existing APIs, and an API Versions Owner can access the API version details pages for the versions they own.

On the API Administration page, Add new API imports an existing API or adds a definition, typically just the API name and version. The API definition, written in RAML, includes the following things:

  • An optional [baseURI node] at the root of the RAML document

  • API resources, for example the collection of all customers or a specific customer

  • HTTP methods, such as GET, POST, PUT, and DELETE, allowed on each resource

  • The representation of the request and response messages for each method, such as GET /customer/1 → response: application/json

The API Administration page also lists the names and versions of the APIs you define or import. Hover over and click the version name area to show details, such as Owners, on the API Administration page:

index-aad67

To start an API management task, click a version name. A page of controls for performing API management tasks on the selected version appears on the API version details page:

index-4908b

Using controls on this page, you can share resources in an organization and perform the following API management tasks:

Some API Manager controls might not be visible or accessible to you, depending on entitlements you purchased.