Skip to main content

🔐 Authentication

To use the caBRAPI API, all requests must be authenticated via an API Key. The API Key is a unique identifier linked to your account and can be obtained in the caBRAPI Dashboard > Settings > API KEY. This key allows the API to identify, validate, and authorize access to the available resources.

🛠️ How to use the API Key

Authentication is performed by sending the API Key in the HTTP Authorization header, following this pattern:

⚠️ Security best practices

  • Do not share your API Key publicly 🔒
  • If the key is compromised, revoke it immediately and generate a new one 🔄
  • Use the API Key only on private routes, that is, those that require authentication 🔑