An API in API Management represents a set of operations that can be invoked by client applications. New APIs are created in the publisher portal, and then the desired operations are added. Once the operations are added, the API is added to a product and can be published. Once an API is published, it can be subscribed to and used by developers.
This guide shows the first step in the process: how to create and configure a new API in API Management. For more information on adding operations and publishing a product, see How to add operations to an API and How to create and publish a product.
APIs are created and configured in the publisher portal. To access the publisher portal, click Publisher portal in the Azure Portal for your API Management service.
Click APIs from the API Management menu on the left, and then click add API.
Use the Add new API window to configure the new API.
The following fields are used to configure the new API.
- Web API name provides a unique and descriptive name for the API. It is displayed in the developer and publisher portals.
- Web service URL references the HTTP service implementing the API. API management forwards requests to this address.
- Web API URL suffix is appended to the base URL for the API management service. The base URL is common for all APIs hosted by an API Management service instance. API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
- Web API URL scheme determines which protocols can be used to access the API. HTTPs is specified by default.
- To optionally add this new API to a product, click the Products (optional) drop-down and choose a product. This step can be repeated multiple times to add the API to multiple products.
Once the desired values are configured, click Save. Once the new API is created, the summary page for the API is displayed in the publisher portal.
You can use the Settings tab to verify and edit the configuration for an API. Web API name, Web service URL, and Web API URL suffix are initially set when the API is created and can be modified here. Description provides an optional description, and Web API URL scheme determines which protocols can be used to access the API.
To configure gateway authentication for the backend service implementing the API, select the Security tab. The With credentials drop-down can be used to configure HTTP basic or Client certificates authentication. To use HTTP basic authentication, simply enter the desired credentials. For information on using client certificate authentication, see How to secure back-end services using client certificate authentication in Azure API Management.
The Security tab can also be used to configure User authorization using OAuth 2.0. For more information, see How to authorize developer accounts using OAuth 2.0 in Azure API Management.
Click Save to save any changes you make to the API settings.
Once an API is created and the settings configured, the next steps are to add the operations to the API, add the API to a product, and publish it so that it is available for developers. For more information, see the following articles.