Skip to main content
Version: ACE 4

Building APIs using API Builder

Creating API Endpoint​

To start creating API click on the "+" icon in the top right corner of ACE, this will open modal window with form to enter API configuraiton parameters.

API Configuration​

Core configuration​

  • Method (required) - the HTPP method to use for the endpoint (GET/ POST / PUT / DELETE)
  • Flow (required) - select the flow that will be executed when this API is called
  • Flow version (required) - select the flow version to use
  • Tag - add tag to API (used for more easy search as well as for exporting by selecting a tag)
  • Path (required) - the path that will execute this API - path variables can be set using {variableName} - e.g. /v1/policy/{policyId}
  • Error tag - the error to return if flow throws an unhandled error
  • Summary - short title for the API (used for redoc / open api 3.0 export)
  • Response description - description of what the API returns (used for redoc / open api 3.0 export)
  • Secured - require authentication to access api, see details in Securing Dynamic API

Parameter configuration​

It is possible to configure the expected parameters that the API expects to receive (path, query and header) by specifying the parameter name, if it is required and also adding description (for redoc / open api 3.0 export). As well as by providing json schema that describes what kind of values are accepted.

Request body schema​

It is possible to define the request body schema either by using a predefined schema from schemas section or by creating a new schema for the request.

Response schema​

It is possible to define the request body schema either by using a predefined schema from schemas section or by creating a new schema for the request. It is possible to define a schema for each response code (e.g 200 - ok, 403 - unauthorized)

Editing an API endpoint​

To edit an API endpoint, click the "edit" icon next to the endpoint that needs to be edited, which will open a modal window for changing the API endpoint configuration.

Deleting API endpoint​

To delete an API endpoint, click on the "delete" icon next to the endpoint that needs to be deleted and confirm deletion.

Testing API endpoint​

To test the endpoint, click on the endpoint to open swagger view and then click Try it out, which will allows passing the required parameters and executing the API call.