メインコンテンツまでスキップ
バージョン: Next

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": { ... }
}
FieldTypeDescription
codeIntegerHTTP status code
messageStringHuman-readable message
dataAnyResponse payload

Error Codes

CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized - Missing or invalid token
403Forbidden - Insufficient permissions
404Not Found - Resource not found
409Conflict - Resource already exists
429Too Many Requests - Rate limit exceeded
500Internal Server Error

Rate Limiting

LimitScope
100 requests/minutePer user (authenticated)
50 requests/minutePer 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

VersionDateChanges
2.02026-08-18Current version
1.02026-07-01Initial release