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 icon next to the app’s name and select API in the menu.
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.
Test a request
You can test your request on the Test tab.
In the Body field, enter your request and click Send.
You will see the response to your request in the Response field.
Select the Get Item function and enter the ID of the app item in the Identifier field. Click Send. You will see the result of the request in the Response field. |