Creating a SOAP API by importing an API from a URL

Edit online

About this task

Let's look at a sample scenario, where you are creating the Calculator SOAP API by importing from the http://www.dneonline.com/calculator.asmx?wsdl URL

Before you begin

Ensure that you have

  • The URL from where you want to import the API
  • Manage APIs or Activate / Deactivate APIs functional privilege. If you are an Administrator you would have this privilege by default.

To create a REST API by importing an API from a file

Procedure

  1. Click APIs in the title navigation bar.
  2. Click Create API.
  3. Select Import from URL.
    Import API from file
  4. Provide the URL as http://www.dneonline.com/calculator.asmx?wsdl.

    As the provided URL is public, you do not have to select the Protected check box. If you have given the restricted access URL and if the URL is password protected, then you must select the Protected check box. After you select the Protected check box, API Gateway displays the Username and Password fields. Make sure you provide the login credentials of the given restricted access URL.

    Based on the specification used in the imported file, API Gateway auto populates the Type field. SOAP API supports the WSDL specifications. As the http://www.dneonline.com/calculator.asmx?wsdl URL is a WSDL file, API Gateway, by default, selects the file type as WSDL.

  5. Provide the API name as Calculator in the Name field.
  6. Provide the version number as 1.0 in the Version field.
  7. Select the Type as WSDL as the imported Calculator API URL references a WSDL file.
  8. Provide a description as Performs basic calculations on the numbers provided in the Description field.
  9. Select the team as Administrator for which you want to assign the Petstore in the Team field.
    This field appears only when the Team feature is enabled. It displays only the teams that you are a part of.
  10. Click Create.
    The Calculator API is created and the API details screen displays.
    REST API details

    The Calculator API is created with the following operations:

    • Add
    • Divide
    • Multiply
    • Subtract
  11. Now that you have created the Calculator API, you can check whether it is imported properly by using any of the API testing tools.

What to do next

Next Steps

Now that you have created the SOAP API, you must

  • Activate the API.
  • Enforce policies based on your business requirement.
  • Publish the API.

For details about the further actions you can perform on the API, see the section All about APIs in the API Gateway User's Guide.