Skip to content

Core Concepts of the Brigit Software API

To effectively use the Brigit Software API, it is important to understand some core concepts. This guide provides an overview of authentication, result limitations, permissions, and response formats.

Authentication

Brigit Software API uses Basic Authentication. This requires sending your username and password encoded in the Authorization header of your HTTP request. For detailed instructions, refer to the Authentication Guide.

Result Limitations

To protect the API from service-breaking calls, the number of results returned by the API is capped. This limit varies depending on the entity being queried. If your search criteria are too broad and exceed the cap, you will receive an HTTP 413: "Payload Too Large" error. Refine your search parameters to avoid this error.

Permissions

The API employs a simple role-based access control system with two roles: Admin and User. When an API user account is created, it is typically assigned the 'User' role. Access to specific endpoints is granted based on these roles. Attempting to access an endpoint without the proper permissions will result in an HTTP 403: "Forbidden" error.

Roles and Access

  • Admin: Has access to all endpoints.
  • User: Has restricted access based on assigned permissions.

Response Formats

By default, all API responses are returned in JSON format. If you require responses in XML format, specify the desired media type in the Accept header of your HTTP request.

Example

To request XML responses:

Accept: application/xml

or

Accept: text/xml