Introduction to Web API

Web API is a set of tools for integrating the platform with external systems.

General information

  • The API works via HTTPS by executing POST and GET requests.
  • Authorization is performed via a token.
  • All the data is available only in the JSON format.
  • The base URL is https://{company}
  • Data queries are possible from any system.

The size of a web request must not exceed 50 MB.

You can learn about the available methods in Public Web API. If needed, the user can add the necessary AI methods in modules. Read more about it in API methods in modules.

Request parameters

The request parameters are passed in:

In the request body, specify the data in the JSON format.

You can read more about the methods used in BRIX in Public Web API.

Checking requests

In the system, you can check whether your request is valid.

To check a request, click the icon next to the app’s name. In the menu that opens, select API.

Select the method you need. At the bottom of the page, open the Test tab. In the Request field, enter the request’s body and click Send.

The result will be displayed in the Result field.

You can read more about the available methods in Public Web API.