ข้อผิดพลาด API

API แจ้งข้อผิดพลาดด้วย HTTP Status Code มาตรฐานและ Response Body ที่เป็นมาตรฐาน การตอบกลับที่สำเร็จจะส่งคืนข้อมูลโดยตรงโดยไม่มี Envelope ครอบ

รูปแบบข้อผิดพลาด

เมื่อเกิดข้อผิดพลาด Response Body จะเป็น JSON Object ที่มีฟิลด์ error หนึ่งฟิลด์ ซึ่งมีข้อความที่อ่านได้:

{"error":"reaction not found"}

ให้ดู HTTP Status Code เป็นหลัก และใช้ข้อความ error สำหรับบันทึกและแจ้งผู้ใช้

Status Code

  • 200 OK — คำร้องสำเร็จ ข้อมูลอยู่ใน Body
  • 201 Created — สร้างทรัพยากรใหม่แล้ว (บาง POST Endpoint)
  • 204 No Content — สำเร็จโดยไม่มี Body (บางการลบ)
  • 400 Bad Request — Body หรือพารามิเตอร์คำร้องไม่ถูกต้อง
  • 401 Unauthorized — โทเค็นไม่มี ไม่ถูกต้อง หรือหมดอายุ หรือเส้นทางนั้นไม่สามารถเข้าถึงได้ด้วย Personal Token
  • 402 Payment Required — การกระทำนั้นติดแพ็กเกจหรือโควต้า (เช่น คลังสื่อของตัวเองต้องการ Premium)
  • 403 Forbidden — โทเค็นขาด Scope ที่จำเป็นสำหรับเส้นทางนี้
  • 404 Not Found — ไม่พบทรัพยากร หรือไม่ได้เป็นของคุณ
  • 409 Conflict — ความขัดแย้งของสถานะ (เช่น ค่าซ้ำซ้อนที่ต้องไม่ซ้ำ)
  • 422 Unprocessable Entity — Body ถูกต้องตาม Syntax แต่ไม่ผ่านการตรวจสอบของโดเมน
  • 429 Too Many Requests — เกินขีดจำกัดคำร้อง (ดู ขีดจำกัด)
  • 500 Internal Server Error — ข้อผิดพลาดภายในเซิร์ฟเวอร์ ลองใหม่ในภายหลัง

วิธีการจัดการ

ถือว่าสำเร็จเมื่อได้รับโค้ด 2xx สำหรับ 401/403 ตรวจสอบโทเค็นและ Scope สำหรับ 4xx (ยกเว้น 429) อย่าส่งคำร้องซ้ำโดยไม่แก้ไข — แก้คำร้องก่อน สำหรับ 429 และ 5xx ให้ลองใหม่ด้วย Exponential Backoff

ขั้นตอนถัดไป