SOAP API details

Edit online

The API details view for a SOAP API displays the details of the API such as Basic and Technical information, Operations available, REST transformation details, and API mocking details. You can also view the specifications, scopes that are associated, policies that are enforced, registered applications, and the API-specific analytics.

The table lists the API details displayed for the API:

Field Description
Basic information Displays the information about the API, such as name, version, description, owner of the API, and the teams that the API is assigned to. Also, you can view the status of the API whether its is Active or Inactive, the maturity state of the API, the date of API creation.
Technical information Displays the native endpoints of the API.
Operations Displays the list of operations available in the API and they are sorted alphabetically. Operations are displayed along with their type of binding (SOAP 11, SOAP 12, and other HTTP methods). Click each method to view details such as input, output, and fault messages.
REST transformation Displays a list of operations that are exposed as REST resources and they are sorted alphabetically. Operations are displayed along with their type of binding. Click each method to view details such as input, output, and fault messages.
API mocking Details are visible only when API mocking is enabled. Displays a list of mocked responses for the operations in the API, custom IS service list and conditions along with its mocked response that contains the status code, and mock payload details.
Documentation Displays the definition of the API in different formats.

Various tabs that are displayed in the API details page display the following details:

  • The Scopes tab lists the scopes available for the API.

  • The Policies tab displays the policies that are enforced for the API.

  • The Applications tab displays all the applications that are registered with the API.

  • The Analytics tab displays the API-specific analytics for the time interval selected.

You can perform the following operations from the API details page.

  • You can enable API mocking by clicking Enable mocking. If API mocking is enabled, you can disable it by clicking Disable mocking. This option is available when the API is in the deactivated state.

  • You can update an API by importing from file or from URL by clicking Update. This option is available when the API is in the deactivated state.

  • You can create a new version of the API by clicking Create new version.

  • You can modify details of an API by clicking Edit. This option is available when the API is in the deactivated state.

  • You can activate an API by clicking Activate . If the API is already activated, you can deactivate it by clicking Deactivate.

Exposing a SOAP API to Applications

  • An active SOAP API exposes its WSDL with a couple of adaptions.

  • The service name becomes the selected API Name.

  • Custom endpoints and URL aliases appear with separate port elements.

  • The HTTP and HTTPS endpoints are exposed if they meet the respective settings in the Transport policy.

  • The SOAP and SOAP12 entries are exposed if they meet the respective settings in the Transport policy.

  • Operations that are enabled are exposed.

  • The values from the Inbound Auth - Message policy are integrated into the WSDL as ws:Policy entries. The original ws:Policy entries from the importing WSDL are not considered.