Mã trạng thái Open API

Giới thiệu

Tài liệu này định nghĩa quy ước mã trạng thái do endpoint Open API trả về, làm rõ kết quả gọi, loại lỗi và nguyên nhân để nhà phát triển chẩn đoán và xử lý nhanh. Tất cả endpoint tuân theo quy tắc này.

Phân loại mã trạng thái

Dải mã	Phân loại
200	Thành công (gọi hoàn tất bình thường)
1xxxx	Lỗi chung (không phân loại cụ thể)
2xxxx	Xác thực và phân quyền
4xxxx	Kiểm tra yêu cầu / tham số
5xxxx	Lỗi liên quan endpoint
6xxxx	Giới hạn tốc độ
7xxxx	Lỗi logic nghiệp vụ

Chi tiết mã trạng thái

1. Thành công

Mã	Enum	Mô tả
200	SUCCESS	Gọi thành công

2. Lỗi chung (1xxxx)

Mã	Enum	Mô tả
10000	UNKNOWN_ERROR	Lỗi không xác định; liên hệ hỗ trợ kỹ thuật

3. Xác thực và phân quyền (2xxxx)

Mã	Enum	Mô tả
20001	API_KEY_MISSING	Thiếu API key (không gửi trong yêu cầu)
20002	API_KEY_INVALID	API key không hợp lệ (bị vô hiệu, hết hạn hoặc chưa được duyệt)
20010	TIMESTAMP_MISSING	Thiếu timestamp (không gửi trong yêu cầu)
20011	TIMESTAMP_FORMAT_ERROR	Định dạng timestamp sai (phải 10 hoặc 13 chữ số)
20012	TIMESTAMP_EXPIRED	Timestamp hết hạn (yêu cầu quá hạn; tạo lại và thử lại)
20020	SIGNATURE_MISSING	Thiếu chữ ký (không gửi trong yêu cầu)
20021	SIGNATURE_VERIFY_FAILED	Xác minh chữ ký thất bại (quy tắc ký sai hoặc tham số bị sửa)

4. Kiểm tra yêu cầu / tham số (4xxxx)

Mã	Enum	Mô tả
400	INVALID_REQUEST	Không parse được request body (kiểm tra định dạng tham số theo tài liệu)
404	NOT_FOUND	Đường dẫn endpoint không tồn tại (kiểm tra path)
405	REQUEST_METHOD_NOT_ALLOWED	Phương thức không được phép (kiểm tra HTTP method theo tài liệu)
40001	REQUIRED_PARAMS_EMPTY	Thiếu tham số bắt buộc
40002	REQUIRED_PARAMS_ILLEGAL	Tham số không hợp lệ (định dạng hoặc giá trị ngoài phạm vi)

5. Lỗi endpoint (5xxxx)

Mã	Enum	Mô tả
50001	INTERFACE_NOT_FOUND	Endpoint API không tồn tại (path sai)

6. Giới hạn tốc độ (6xxxx)

Mã	Enum	Mô tả
60001	INTERFACE_RATE_LIMIT	Vượt giới hạn tần suất; thử lại sau

7. Logic nghiệp vụ (7xxxx)

Mã	Enum	Mô tả
70001	NOT_ENOUGH_CREDIT	Số dư tài khoản không đủ; vui lòng nạp thêm