HTTP Status Codes
The API uses standard HTTP status codes. The following are commonly used status codes and their meanings:| Status Code | Meaning | Description |
|---|---|---|
| 200 | OK | Request was successful |
| 201 | Created | Resource was successfully created |
| 204 | No Content | Request was successful but there is no content |
| 400 | Bad Request | There is an error in the request (invalid parameter, etc.) |
| 401 | Unauthorized | Authentication information is invalid or missing |
| 403 | Forbidden | No access permission |
| 404 | Not Found | The requested resource does not exist |
| 422 | Unprocessable Entity | The request format is correct but semantically incorrect |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server internal error |
Error Response Format
When an error occurs, the API returns a JSON response in the following format:Response Fields
| Field | Type | Description |
|---|---|---|
statusCode | integer | HTTP status code |
errorId | string | Error identifier |
message | string | Brief description of the error |
errorDetails | array | Detailed error information (if available) |
Common Errors
Authentication Error (401)
Permission Error (403)
Validation Error (422)
Error Handling Best Practices
- Properly handle all HTTP status codes
- Implement retry logic especially for 429 (rate limit) errors
- Log error messages to help diagnose problems
- Display user-friendly error messages to users
- Do not include sensitive information in error messages

