Creating a SOAP API by importing an API from a file

Edit online

Before you begin

Make sure that you have

  • Downloaded the SOAP API file with WSDL specifications.
  • Manage APIs or Activate / Deactivate APIs functional privilege.
    Note: If you are an Administrator, you must have this privilege.

About this task

This example explains how you can create a SOAP API by importing the numberconversion.wsdl file.

Procedure

  1. Download numberconversion.wsdl from https://www.dataaccess.com/webservicesserver/numberconversion.wso?WSDL
  2. Open the menu options and select APIs.
  3. Click Create API.
  4. Select Import API from file.
  5. Click Browse and select the numberconversion.wsdl file.
  6. Click Open.
    Note: Based on the specification used in the imported file, webMethods API Gateway auto populates the Type field. SOAP API supports the WSDL specifications.
  7. Provide the API name as NumberConverter in the Name field.
    • If you provide an API name, webMethods API Gateway overwrites the API name that is specified in the uploaded file.
    • If you do not provide an API name, the webMethods API Gateway retains the API name that is specified in the uploaded file.
    • If you do not provide an API name and the uploaded file does not have an API name, then the API name is displayed as Untitled.
  8. Provide the version number as 1.0 in the Version field.
  9. Select the TypeType as since the imported NumberConverter API is a WSDL file.
  10. Provide the description as Converts numbers to words or dollars in the Description field.
  11. Select the team as TestAPITeam for which you want to assign the NumberConverter API in the Team field.
    Note: This field appears only when the Team feature is enabled. It displays only the teams that you are a part of. If you have the User management functional privilege, all teams are displayed. You can select more than one team.
  12. Click Create.
    The NumberConverter API is created with the following operations:
    1. NumberToDollars
    2. NumberToWords
  13. Now that you created the NumberConverter API, you can check whether it is imported properly by using any of the API testing tools. To know more about how to test the SOAP API, see Testing the imported SOAP API by using SOAPUI.