Tutorial: Create or link an API Center to API Management

This tutorial shows how to integrate an Azure API Management instance with an Azure API Center. When linked, the API Management instance's APIs — and optional API definitions — are continuously synchronized into the API Center inventory. API Center is a central catalog and governance hub for APIs and related artifacts, and API Management customers use it to discover and reuse APIs, share definitions across teams, and apply consistent governance and lifecycle policies.

Note

Only one API Center can be linked to a single API Management instance.

In this tutorial, you:

• Create a new API Center and link it to an API Management instance
• Link an existing API Center and synchronize APIs
• View synchronized APIs and remove the link if needed

Prerequisites

Before you start, make sure you meet the following requirements.

• An Azure account with an active subscription is required. If you don't already have one, you can create an account for free.
• An existing API Management service in the subscription where you want to manage APIs
• Contributor (or Owner) permissions on the API Management resource and permission to create resources in a resource group

Create a new API Center and link your APIs

These steps show how to create a new API Center and link it to an API Management instance so APIs are synchronized.

1. From the Azure portal, open your API Management service.

2. In the left-hand menu, go to APIs > API Center.

3. In the center pane, under Use API Center for API discovery, reuse, and governance, select Create new.

4. On the Create API Center page, select Create new link.

5. Provide values for the following fields:

   Field	Details
   Resource group	Select an existing resource group or create a new one.
   Location	Choose a region. Regions available for API Center may differ from the region of your API Management instance.
   Name	Provide a unique name for the API Center instance.
   Pricing plan	Select a plan.
   Lifecycle	Select the lifecycle state to associate with APIs when they're synchronized. This metadata can be changed later.

6. Select Create.

   • When the operation finishes, you should see a Request succeeded message and a confirmation that your API Management service and API Center are synchronized.

Use an existing API Center

These steps show how to link an API Management instance to an API Center that already exists.

1. From the API Center section of your API Management service, select Use existing API Center.
2. From the dropdown, choose the API Center you want to link.
3. Select Synchronize APIs to start synchronization between the API Management service and the selected API Center.

View linked API Center and synchronized APIs

Use this section to verify the integration state and to view APIs that synchronized from API Management.

1. In the Azure portal, open the API Center resource.
2. In the API Center left-hand menu, go to Platforms > Integrations. The state for the integration with API Management should say Linked and syncing.
3. To view synchronized APIs, go to Assets > APIs.
   An icon appears indicating that the APIs are linked.

Remove link to API Center

Follow these steps to remove the link between API Management and the API Center or to delete the API Center resource.

1. In the API Center resource, find the linked API Management instance.
2. In the left-hand menu, go to Platforms > Integrations.
3. Select the trash can icon to delete the link.

Clean up resources

Delete any resources you created for this tutorial to avoid incurring charges.

If you created an API Center for this tutorial and no longer need it, delete the API Center resource and any resource group you created to avoid charges.

Related content

Synchronize APIs from an API Management instance