Circuit Auction Backoffice API Documentation
Comprehensive REST API for managing auction operations including clients, orders, items, sales, and more.
Base URL
https://backoffice.ddev.site/api/v1.0/
Authentication
All endpoints require a Bearer token obtained via the authentication endpoint.
POST /bo_auth
Request:
{
"username": "user@example.com",
"password": "securePassword123"
}
Response:
{
"data": {
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
"user": { ... }
}
}
Use the access_token in the Authorization header:
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGc...
Client Addresses
Manage client addresses, set default addresses, and handle address types.
View Addresses APITransactions
Record and manage payment transactions, cheques, and wire transfers.
View Transactions APIDocumentation
Key Features
- Advanced filtering, sorting, and pagination
- Bulk operations for efficiency
- File and image uploads
- Activity logging and audit trails
- Comprehensive error handling
- RESTful API design
- JWT authentication
- JSON request/response format
- Queue-based background jobs
- Rate limiting protection
Available Endpoints
Clients
6 endpointsAddresses
5 endpointsOrders
7 endpointsItems
4 endpointsSales
4 endpointsTransactions
2 endpointsFiles
1 endpointQueue
1 endpointBulk
1 endpoint
Last Updated: October 30, 2025 | API Version: 1.0