ข้อควรทราบ
1. URL พื้นฐาน
| สภาพแวดล้อม | ที่อยู่ |
|---|---|
| โปรดักชัน | https://openapi.fastmoss.com |
2. เมธอดคำขอ
คำขอ API ทั้งหมดใช้เมธอด POST
3. รูปแบบการตอบกลับ
การตอบกลับ API ทั้งหมดส่งคืนในรูปแบบ JSON object ฟิลด์ data จะมีข้อมูลเฉพาะซึ่งเป็น Json object
| ชื่อพารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
code | integer | รหัสสถานะ |
msg | string | ข้อความ |
data | object | ข้อมูล |
request_id | string | id คำขอ |
timestamp | timestamp[integer] | timestamp เซิร์ฟเวอร์ |
ตัวอย่าง
json
{
"code": 0,
"msg": "success",
"data": {
"xxx": "xxx"
},
"request_id": "xxxx",
"timestamp": 1690351112
}4. ความสัมพันธ์ระหว่าง HTTP Status Code และ Code
HTTP Status CodeและCodeไม่ขัดแย้งกันCodeแสดงถึงรหัสสถานะทางธุรกิจที่ระบุ- คุณควรตรวจสอบ
HTTP Status Codeก่อน แล้วจึงตรวจสอบCode - เมื่อ
HTTP Status Codeเป็น200และCodeเป็น0แสดงว่าสำเร็จ
คำอธิบายรหัสสถานะ
| รหัสสถานะ | ประเภท | คำอธิบาย |
|---|---|---|
0 | ไม่มีข้อยกเว้น | สำเร็จ |
10001 | พารามิเตอร์ผิดพลาด | พารามิเตอร์ไม่ตรงตามข้อกำหนด |
20001 | ข้อมูลผิดพลาด | ไม่พบทรัพยากร |
30001 | ข้อผิดพลาดด้านสิทธิ์ | ไม่มีสิทธิ์เข้าถึง |
30002 | ข้อผิดพลาดด้านสิทธิ์ | เกินขีดจำกัดข้อมูล |
30003 | ข้อผิดพลาดด้านสิทธิ์ | เกินขีดจำกัดความถี่ในการเข้าถึง |
40001 | บริการผิดพลาด | ข้อยกเว้นของบริการ |