Low-code designer > App builder / APIs in apps

API in apps

BRIX API is a tool used to integrate BRIX with external systems.

With API methods you can create and edit app items or obtain data from them using just one request.

Read more about API methods in BRIX Public API.

The API page in an app allows you to test the requests that you write.

API page in apps

To open the API page, click the app gear icon icon next to the apps name and select API in the menu.

app-api-1

The API page of an app displays:

  • Available functions. For more information, please visit BRIX Public API.
  • Description of each function.
  • The method name.
  • Request URL for the app.
  • Request template.
  • Possibility to test the request that you write.

Request template

You can find the request template on the JSON Package tab.

api_apps_01

Test a request

You can test your request on the Test tab.

In the Body field, enter your request and click Send.

api_apps2

You will see the response to your request in the Response field.

api_apps3

Example of testing a request