API Explorer

The API Explorer is a user interface for the documentation and testing of Flow API Endpoints, based on Swagger UI.

Access

For the API Explorer to be reachable in a given environment, the Enable Flow Service checkbox must be selected in the Environment Configuration.

There are several ways to access the API Explorer:

• Visit the URL https://SOLUTION-HOSTNAME/api/flows/inspect. Note that the solution hostname is environment-specific.

• Inside a Flow, click the tools icon in the toolbar, then click API Explorer for the relevant environment.

Access to the API Explorer is authenticated and requires a role with client access to that specific environment.

Usage

All endpoints are grouped by Flow. By expanding an endpoint, you can view its details and parameters. Click Try it out to enable the parameter input fields and reveal an Execute button. Clicking Execute will call the endpoint with the specified parameters and reveal the response.

Note that when you execute an endpoint from the API Explorer, the endpoint is run by your user with the corresponding role(s). This means that during testing, you will often have full access to all object classes and Flows. When an endpoint is triggered by an external system, a service account is used. If an endpoint works for you but not when called by an external system, make sure the service account has sufficient permissions.

If you use a tool like Postman or need to share details of your API with an external party, you can download an OpenAPI specification of your Flow endpoints. The specification can be downloaded at https://SOLUTION-HOSTNAME/api/flows/openapi.json.