API Reference
Dimebia provides a RESTful API for all operations. This section contains the complete API reference.
Base URL
https://api.dimebia.com/api
For local development:
http://localhost:8080/api
Authentication
All API requests require authentication unless marked as public.
JWT Bearer Token
Authorization: Bearer <access_token>
API Key
Authorization: ApiKey <secret_key>
Response Format
All responses follow a standard format:
{
"code": 200,
"message": "Success",
"data": { ... }
}
| Field | Type | Description |
|---|---|---|
code | Integer | HTTP status code |
message | String | Human-readable message |
data | Any | Response payload |
Error Codes
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Missing or invalid token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource not found |
| 409 | Conflict - Resource already exists |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
Rate Limiting
| Limit | Scope |
|---|---|
| 100 requests/minute | Per user (authenticated) |
| 50 requests/minute | Per IP address (unauthenticated) |
Rate limit headers are included in all responses:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1724000000
Pagination
List endpoints support pagination:
GET /api/transaction/list?page=1&pageSize=20
Response includes pagination metadata:
{
"code": 200,
"data": [...],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 100,
"totalPages": 5
}
}
Filtering
Most list endpoints support filtering:
GET /api/transaction/list?status=SUCCESS&channelId=1&startDate=2026-01-01&endDate=2026-12-31
Sorting
GET /api/transaction/list?sortBy=createdTime&sortOrder=desc
Idempotency
To prevent duplicate operations, use the Idempotency-Key header:
POST /api/transaction/create
Idempotency-Key: unique-key-123
SDKs
Official SDKs are available for:
Changelog
| Version | Date | Changes |
|---|---|---|
| 2.0 | 2026-08-18 | Current version |
| 1.0 | 2026-07-01 | Initial release |