Trying SOAP APIs

Before you begin

  • If the API that you are trying is protected with an API key, then create an application to establish your identification. For information about creating applications, see Creating applications.
  • Expand the menu options, click Administration, and click General. Turn the Enable SSL validation for tryout setting off. By default, this setting is enabled. You must turn off this setting to test APIs.

Procedure

  1. Go to the Try API page by using one of the following ways:
    1. Click the Tryout icon Tryout icon in the corresponding API tile.
    2. Click Try API from the API details page of the corresponding API.
    The Try API page appears. The SOAP methods that you can test appear in the left pane.
  2. Select a method according to your requirements.
  3. Provide the following values in the Parameters tab:
    • Key. Key value of the parameter.
    • Value. Value of the corresponding key parameter.

    You can click Add new and add multiple entries.

  4. Provide the header details from the Headers tab:
    1. To include header key value combinations, provide the following values.
      • Key. Value of the header key.
      • Value. Value of the corresponding key parameter.

        You can click Add new and add multiple entries.

    2. To include a SOAP header.
      • Name. A unique name to distinguish the provided SOAP headers, when a API includes multiple headers.
      • Click Add new namespace URI to provide unique Key elements and corresponding Value attributes for the header content. You can provide multiple key and value combinations by clicking Add new namespace URI.
      • Header content.

        You can click Add SOAP header to provide more headers.

  5. Provide the authorization details from the Authorization tab.
  6. Optional: If the SOAP API is protected with web service security (WSS), select an authorization method from the Web Service Security tab.
    • WSS user token. Select the the field to provide WSS username and password.
      • Provide the username and password for WSS authorization.
      • Select the Add nonce checkbox to include nonce, which is a randomly generated number that is included in the request header that is sent to the API server. Nonce is generated every time that a request is sent to the API server and thus, adding a nonce to the request along with WSS user token prevents reuse of old communications.
      • Select the Add creation time checkbox to add a timestamp that the nonce was created. This value helps the server to ensure that the outdated nonce values are not reused.
      • Select Password text to send the password as plain text. Else, select Password digest to encrypt the password.
    • WSS SAML assertion. Select the checkbox to include SAML assertion for WSS authorization. You can either paste the assertion or upload the assertion file.

      You can include both, WSS user token and SAML assertion, in your request. You can select either of these options, provide details, and then the other option without pressing Clear. So, the details that are provided for both options are included to the request.

  7. In the Request body tab, provide your request in the form of key-value pairs or raw text and click Send.
    The response body and headers appear in their respective sections.