Điều cần lưu ý
1. URL cơ sở
| Môi trường | Địa chỉ |
|---|---|
| Sản xuất | https://openapi.fastmoss.com |
2. Phương thức yêu cầu
Tất cả các yêu cầu API đều dùng phương thức POST.
3. Định dạng phản hồi
Tất cả phản hồi API được trả về ở định dạng JSON object. Trường data chứa dữ liệu cụ thể, là một Json object.
| Tên tham số | Kiểu | Mô tả |
|---|---|---|
code | integer | Mã trạng thái |
msg | string | Thông báo |
data | object | Dữ liệu |
request_id | string | id yêu cầu |
timestamp | timestamp[integer] | timestamp máy chủ |
Ví dụ
json
{
"code": 0,
"msg": "success",
"data": {
"xxx": "xxx"
},
"request_id": "xxxx",
"timestamp": 1690351112
}4. Mối quan hệ giữa HTTP Status Code và Code
HTTP Status CodevàCodekhông xung đột.Codebiểu thị mã trạng thái nghiệp vụ cụ thể.- Bạn nên kiểm tra
HTTP Status Codetrước, sau đó kiểm traCode. - Khi
HTTP Status Codelà200vàCodelà0, điều đó cho biết thành công.
Mô tả mã trạng thái
| Mã trạng thái | Kiểu | Mô tả |
|---|---|---|
0 | Không có ngoại lệ | Thành công |
10001 | Lỗi tham số | Tham số không đạt yêu cầu |
20001 | Lỗi dữ liệu | Không tìm thấy tài nguyên |
30001 | Lỗi quyền truy cập | Không có quyền truy cập |
30002 | Lỗi quyền truy cập | Vượt quá giới hạn dữ liệu |
30003 | Lỗi quyền truy cập | Vượt quá giới hạn tần suất truy cập |
40001 | Lỗi dịch vụ | Ngoại lệ dịch vụ |