Configuring a SOAP API definition

You can configure the details for a SOAP API definition. For example, you can select the service endpoint to which requests are sent.

Before you begin

You must complete one of the following tasks:
Important: If you are using API Connect in the cloud, then the services that you expose must be visible on the Internet, they must not be accessible only from within your corporate intranet. However, you can use TLS profiles configured in API Manager to protect the communication channel between the API Gateway in API Connect and the services that you expose on the Internet through your DMZ. You can also use the IBM® Cloud Secure Gateway service to provide secure access to your on-premises services from IBM API Connect for IBM Cloud; for more information, see About Secure Gateway.

About this task

After you create a SOAP API definition, you can specify API details to ensure the API starts and runs properly.

Procedure

To configure a SOAP API definition, complete the following steps:

  1. If you have not previously pinned the UI navigation pane then click the Navigate to icon The Navigate to icon.
    The API Manager UI navigation pane opens. To pin the UI navigation pane, click the Pin menu icon The Pin menu icon..
  2. Click Drafts in the UI navigation pane, and then click APIs.
    The APIs tab opens.
  3. Click the name of the SOAP API definition that you want to configure.
  4. Configure the SOAP API definition as you would a REST API definition.
    Paths, operations, and definitions have already been created. In the assembly view, there is a proxy policy that invokes the service's URL. In the source view, additional configuration for your SOAP API can be found that is not displayed in the design view. For more information about configuring an API definition, see Composing a REST API definition.

Results

The endpoint is associated with the SOAP API.

What to do next

You can now test the invocation of the API by using the embedded test tool in the Assemble tab, see Testing an API with API Manager test tool or Testing an API with the API Designer test tool.