Billie Connect Converse API Prerequisites
Technical Requirements
- OAuth 2.0 Implementation
- Client must implement OAuth 2.0 client credential flow
- Support for JWT token handling
- Token caching mechanisms
- API Client Configuration
- HTTPS support for secure communication
- JSON request/response handling
- Bearer token authentication headers
- Webhook Support (v3 only)
- Public HTTPS endpoint for receiving webhook callbacks
- SSL/TLS certificate validation
- Request signature verification (recommended)
- Client Registration
- Valid client number (clientNo) assigned by Aria
- OAuth 2.0 credentials (client_id, client_secret) configured through a service account
1. Configure Client Parameters
You must set the following client parameters in your Aria instance:
| Parameter ID | Description |
|---|---|
| ENABLE_BILLIE_CONNECT_SERVICE | Enable/disable Billie Connect service (must be enabled) |
2. Create a Billie Service Account
- Create a service account with a unique name.
- Once the Service account is saved, access that, return to the update screen, and generate a key.
Note: Don't forget to save your key because it is not recoverable.