Skip to main content
Version: ACE 5

Build APIs using API Builder

Creating API Endpoint​

To start creating API click on the "+ ADD API OPERATION" icon in the ACE Apis section, this will open form to enter API configuration parameters.

API Configuration​

Core configuration​

  • Path (required) - the path that will execute this API - path variables can be set using {variableName} - e.g. /v1/policy/{policyId}
  • Name (required) - the filesystem name of the API
  • Method (required) - the HTTP method to use for the endpoint (GET/ POST / PUT / DELETE/ OPTIONS/ TRACE/ HEAD/ PATCH)
  • Flow (required) - select the flow that will be executed when this API is called
  • Tag - add tag to API (used for more easy search as well as for exporting by selecting a tag)
  • Error tag - the error to return if flow throws an unhandled error
  • OperationId (required) - the unique identifier required for OpenAPI definition
  • 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's possible to configure expected parameters for the API, such as path, query and header parameters. Setting a description is not required, but it makes the API more readable when viewed in redoc or after exporting as OpenAPI. The parameter type can be selected from the drop down.

It's also possible to select a pre-defined schema by selecting 'schema' as parameter type and choosing from the drop-down, or by typing a schema name and pressing enter to create a new one.

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 schema to each response code (e..g 2000 - ok, 403 - unauthorized)

Custom properties​

Custom properties can be added to the API. These properties will be available in the $api global variable during execution.

Editing an API endpoint​

To edit an api, click on the api in the apis section which opens api form with the api values which allows to edit and save the api.

Deleting API endpoint​

To delete an API endpoint click on "delete" icon next to the endpoint needed to be deleted.

Testing API endpoint​

To test the endpoint, click on the particular endpoints Try it out option from list that will allows passing the required parameters and executing the API call.