BSS.API
Introduction
You can interact with the BSS API through HTTP requests from any language. Currently, we do not provide a SDK for any language, but you can use the API with your preferred programming language.
Authentication
API Keys
The BSS API uses API keys for authentication. You can create API keys at the company level. These keys are essential for accessing and interacting with the BSS API.
Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.
All API requests should include your API key in an Authorization HTTP header as follows:
X-Api-Key: bss_BSS_API_KEY
For more details on setting up and managing your API key, please refer to the API Key Management documentation.
Making Requests
You can interact with the BSS API using HTTP requests in the language of your choice. Below is an example of how to include the API key in your requests using cURL:
Example using cURL
The following cURL request returns all companies that the API key has access to:
curl -L 'https://portal.brandsecuresystem.com/api/v1/Company' \
-H 'Accept: application/json' \
-H 'X-Api-Key: bss_BSS_API_KEY'