API Builder Overview

Introduction

API Builder provides an easy way to create API endpoints that are linked to the flows built with Flow Builder. It is possible to define API request and response schema`s that are later are used to create Open API 3.0 json schema.

API builder also allows importing existing API definitions and schemas and automatically creates flows that connect to provided APIs allowing for easy integration with existing and 3rd party services.

Furthermore using the swagger view it is possible to execute API calls to test the response created by the flow that is attached to the API. The created API documentation is also available in redoc format.

APIs

API Builder allows business experts to provide contextual and semantic apis, based on OpenAPI 3.0 standard.

Once API definition is ready, API can be linked to the flow. What happens the is that once API is invoked, whatever is the input of the API is sent in the doc to the mapped Flow and executed.

Whatever Flow returns in doc.result node is returned as an output of the API.