Authentication
The ProAbono API Live uses HTTP Basic Auth — an Agent Key and an API Key encoded together in the Authorization header.
Getting your credentials
- Log into the ProAbono backoffice.
- Go to the Integration section.
- Copy the Agent Key and the API Key.
Caution
Treat these keys like passwords. Store them in environment variables or a secrets manager — never commit them to source code.
Base URL
The base URL is specific to your Business. IdBusiness is the internal numeric identifier visible in the backoffice Integration section.
| Environment | Base URL |
|---|---|
| Production | https://api-<IdBusiness>.proabono.com/ |
The Authorization header
Encode your credentials as:
Authorization: Basic <base64(AgentKey:ApiKey)>
Note
All requests and responses use Content-Type: application/json.
Auth-related error codes
| Status | Meaning |
|---|---|
401 Unauthorized | Credentials are missing or invalid |
403 Forbidden | Credentials are valid but the action is not permitted |
See Conventions for the full list of HTTP status codes.