Import SOAP API

This article shows how to import a standard XML representation of a SOAP API. The article also shows how to test the APIM 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

Prerequisites

Complete the following quickstart: Create an Azure API Management instance

Go to your API Management instance

Navigate to API Management instance

  1. Sign in to the Azure portal.

  2. Select All services.

  3. In the search box, enter api management.

  4. In the search results, select API Management services.

  5. Select your API Management service instance.

Tip

To add API Management to your favorites in the Azure portal, select the star.

The API Management icon (API Management icon) now appears in the left menu in the portal.

Import and publish a back-end API

  1. Select APIs from under API MANAGEMENT.
  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.

    Pass-through

  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 APIM instance. It has to be unique in this APIM 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 APIM 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. Select Create.

Test the new APIM 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 APIM instance, you are an administrator already, so the key is filled in automatically.

  4. Press Send.

    Backend responds with 200 OK and some data.

Call an operation from the developer portal

Operations can also be called Developer portal to test APIs.

  1. Select the API you created in the "Import and publish a back-end API" step.
  2. Press Developer portal.

    The "Developer portal" site opens up.

  3. Select the API that you created.
  4. Click the operation you want to test.
  5. Press Try it.
  6. Press Send.

    After an operation is invoked, the developer portal displays the Response status, the Response headers, and any Response content.

Append other APIs

An API can be composed of APIs exposed by different services, including the OpenAPI Specification, a SOAP API, the API Apps feature of Azure App Service, Azure Function App, Azure Logic Apps, and Azure Service Fabric.

Import an API

To append a different API to your existing API, complete 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.
  2. Select APIs from the menu on the left.
  3. Click ... next to the API that you want to append another API to.
  4. Select Import from the drop-down menu.
  5. Select a service from which to import an API.

Next steps