API testing

You cannot use Test mode within an API process because the Web Services Server connector is listen-only and cannot be triggered in real time when in this mode.

Here are the basic steps to test an API process:

1. Deploy the process to an runtime cloud or to a local runtime to launch Web Services Server.

2. If you are using an API Service component to define the API endpoint(s), deploy the component.

3. Trigger the client application work flow that invokes the API by sending an outbound message to the runtime's endpoint URL.

4. Review the process execution and inbound document data on the Manage menu's Process Reporting page. A new execution thread should be visible after a successful send from the client application to the runtime's web server.

5. Save a copy of the inbound request data to a local file.

Consider using the FTP or Disk connector in the Start step to retrieve the request XML, JSON, or file data that you intend to send through the API process. This allows you to simulate the document flow in Test mode without having to fully deploy the process to an runtime.

Client-side testing with Postman

Postman is an API platform that allows you to build and test APIs.

Client-side testing with SoapUI

SoapUI is a testing tool that enables you to work interactively with API clients or implementations and to run tests of SOAP-based APIs in a continuous integration environment. It is best to use SoapUI to test APIs processes where the full SOAP URL is available. Consider getting the SoapUI NG Pro version to do more extensive testing with HTTP messages.