This article shows how to import a standard XML representation of a SOAP API. The article also shows how to test the API Management API.

In this article, you learn how to:

  • Import SOAP API
  • Test the API in the Azure portal
  • Test the API in the Developer portal


Complete the following quickstart: Create an Azure API Management instance

Go to your API Management instance

  1. In the Azure portal, search for and select API Management services.

    Select API Management services

  2. On the API Management services page, select your API Management instance.

    Select your API Management instance

Import and publish a back-end API

  1. Navigate to your API Management service in the Azure portal and select APIs from the menu.

  2. Select WSDL from the Add a new API list.

    Soap api

  3. In the WSDL specification, enter the URL to where your SOAP API resides.

  4. The SOAP pass-through radio button is selected by default. With this selection, the API is going to be exposed as SOAP. Consumer has to use SOAP rules. If you want to "restify" the API, follow the steps in Import a SOAP API and convert it to REST.

    Screenshot shows the Create from W S D L dialog box where you can enter a W S D L specification.

  5. Press tab.

    The following fields get filled up with the info from the SOAP API: Display name, Name, Description.

  6. Add an API URL suffix. The suffix is a name that identifies this specific API in this API Management instance. It has to be unique in this API Management instance.

  7. Publish the API by associating the API with a product. In this case, the "Unlimited" product is used. If you want for the API to be published and be available to developers, add it to a product. You can do it during API creation or set it later.

    Products are associations of one or more APIs. You can include a number of APIs and offer them to developers through the developer portal. Developers must first subscribe to a product to get access to the API. When they subscribe, they get a subscription key that is good for any API in that product. If you created the API Management instance, you are an administrator already, so you are subscribed to every product by default.

    By default, each API Management instance comes with two sample products:

    • Starter
    • Unlimited
  8. Enter other API settings. You can set the values during creation or configure them later by going to the Settings tab. The settings are explained in the Import and publish your first API tutorial.

  9. Select Create.

Test the new API in the administrative portal

Operations can be called directly from the administrative portal, which provides a convenient way to view and test the operations of an API.

  1. Select the API you created in the previous step.

  2. Press the Test tab.

  3. Select some operation.

    The page displays fields for query parameters and fields for the headers. One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. If you created the API Management instance, you are an administrator already, so the key is filled in automatically.

  4. Press Send.

    Backend responds with 200 OK and some data.

Append other APIs

You can compose an API of APIs exposed by different services, including:

  • The OpenAPI Specification
  • A Web App hosted in Azure App Service
  • Azure Function App
  • Azure Logic Apps
  • Azure Service Fabric

Append a different API to your existing API using the following steps.


When you import another API, the operations are appended to your current API.

  1. Go to your Azure API Management instance in the Azure portal.

    Go to Azure API Mgmt instance

  2. Select APIs on the Overview page or from the menu on the left.

    Select APIs

  3. Click ... next to the API that you want to append another API to.

  4. Select Import from the drop-down menu.

    Select import

  5. Select a service from which to import an API.

    Select service

Next steps