เริ่มต้นใช้งาน

ข้อผิดพลาด

เมื่อเกิดข้อผิดพลาด API จะตอบกลับด้วยสถานะ HTTP ที่ตรงกัน และเนื้อหาที่มี code และ message อยู่ภายใน error

ใช้ code ในโปรแกรมของคุณ ส่วน message เป็นข้อความภาษาอังกฤษที่ช่วยผู้ที่กำลังดีบัก และอาจมีการเปลี่ยนแปลง

รูปแบบข้อผิดพลาด404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}
ไม่มีคีย์401
{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

รหัสข้อผิดพลาด

สถานะ รหัส เกิดขึ้นเมื่อ
400 key_in_query มีการส่งคีย์มาใน URL (พารามิเตอร์ api_key, apikey, key หรือ token) ให้ส่งคีย์ในส่วนหัวและสร้างคีย์ใหม่ เพราะคีย์เดิมอาจถูกบันทึกไว้ในล็อกแล้ว
400 invalid_parameter พารามิเตอร์มีค่าไม่ถูกต้อง เช่น per_page เกินค่าสูงสุด
401 missing_api_key คำขอไม่ได้แนบคีย์มา
401 invalid_api_key ไม่มีคีย์นี้อยู่ คีย์ถูกเพิกถอนแล้ว หรือผู้ใช้เจ้าของคีย์ถูกปิดใช้งาน
404 not_found ไม่มีเอนด์พอยต์นี้ หรือไม่มีรายการนี้ หรือรายการเป็นขององค์กรที่ผู้ใช้ไม่มีสิทธิ์ดู
404 organization_not_found organization ที่ระบุไม่ใช่องค์กรที่ผู้ใช้มีสิทธิ์ดูรายการประเภทนี้
405 method_not_allowed API รับเฉพาะ GET (และ HEAD)
429 rate_limited ถึงขีดจำกัดคำขอแล้ว ให้รอตามจำนวนวินาทีใน Retry-After
500 server_error ข้อผิดพลาดภายใน โปรดลองอีกครั้งในอีกสักครู่ หากยังเกิดขึ้นอีก โปรดติดต่อฝ่ายสนับสนุน

เมื่อใดควรลองใหม่

ส่งคำขอเดิมซ้ำได้เฉพาะหลังได้รับ 429 (โดยรอตาม Retry-After) หรือ 500 เท่านั้น ข้อผิดพลาดอื่นต้องแก้ไขที่คำขอหรือคีย์