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

โครงสร้างการตอบกลับ

อ่านออบเจ็กต์ข้อผิดพลาด

เมื่อคำขอล้มเหลว JSON จะส่ง status เป็น false ใช้ตัวเลข errno สำหรับตรรกะในแอปพลิเคชัน และเก็บ errmsg ไว้สำหรับ log หรือข้อความวินิจฉัยที่อ่านเข้าใจได้

JSON · ตัวอย่างข้อผิดพลาด

{
  "status": false,
  "errno": 94,
  "errmsg": "invalid or missing key"
}

หลักการนำไปใช้: แยกเงื่อนไขด้วย errno ไม่ใช่ข้อความตรงตัวใน errmsg เพื่อให้ integration ทำงานคงที่แม้คำอธิบายจะเปลี่ยนในภายหลัง

ข้อมูลอ้างอิงทั้งหมด

ค่าต่อไปนี้ตรงกับเอกสาร GenderAPI สาธารณะในปัจจุบัน ควรแก้ไขสาเหตุก่อนส่งคำขอซ้ำ

errno50

access denied

คำขอมาจาก IP address หรือ referrer ที่ไม่ได้รับอนุญาต

ตรวจสอบข้อจำกัดการเข้าถึงที่กำหนดให้กับ API key

errno90

invalid country code

ค่า country ไม่ใช่รหัส ISO 3166-1 alpha-2 ที่รองรับ

ตรวจสอบและปรับรหัสประเทศให้เป็นมาตรฐานก่อนลองใหม่

errno91

name not set || email not set || username not set

คำขอไม่มีพารามิเตอร์ name, email หรือ username ที่ endpoint กำหนด

เพิ่มข้อมูลอินพุตที่จำเป็นสำหรับ endpoint ที่เรียกใช้

errno92

too many names || too many emails || too many usernames

คำขอเกินขีดจำกัดแบบกลุ่ม: ชื่อ 100 รายการ อีเมล 50 รายการ หรือชื่อผู้ใช้ 50 รายการ

แบ่งข้อมูลเป็นกลุ่มย่อยและส่งแยกกัน

errno93

query limit reached

API key ไม่มีเครดิตคงเหลือ

หยุดงานค้นหาชั่วคราวและเติมเครดิตในบัญชี

errno94

invalid or missing key

ไม่มี API key หรือระบบไม่พบ key ที่ส่งมา

ตรวจสอบการส่งข้อมูลรับรองและใช้ key ฝั่งเซิร์ฟเวอร์ที่ถูกต้อง

errno99

API key has expired

แพ็กเกจที่เชื่อมโยงกับ API key หมดอายุแล้ว

ต่ออายุแพ็กเกจก่อนส่งคำขอค้นหาครั้งถัดไป

แนวทางการจัดการ

หยุดอย่างปลอดภัยและหลีกเลี่ยงการลองซ้ำโดยไม่ตรวจสอบ

ตรวจสอบข้อมูลก่อน

ปฏิเสธอินพุตที่ขาดหาย รหัสประเทศไม่ถูกต้อง และกลุ่มข้อมูลที่เกินขีดจำกัดก่อนส่งไปยัง API

ปกป้องข้อมูลรับรอง

เก็บ API key ไว้บนเซิร์ฟเวอร์ และลบออกจาก log ของแอปพลิเคชัน ผลลัพธ์ในเบราว์เซอร์ และภาพหน้าจอสำหรับทีมสนับสนุน

เลือกลองซ้ำเฉพาะกรณี

ข้อผิดพลาดเหล่านี้ต้องแก้ข้อมูลหรือดำเนินการกับบัญชี การส่งคำขอเดิมซ้ำโดยไม่เปลี่ยนแปลงจะไม่ช่วยแก้ปัญหา

TypeScript · ตัวตรวจสอบการตอบกลับ

type GenderApiError = {
  status: false;
  errno: number;
  errmsg: string;
};

if (response.status === false) {
  handleGenderApiError(response.errno, response.errmsg);
}

เก็บรายละเอียดการวินิจฉัยเป็นข้อมูลภายใน

บันทึกหมายเลขข้อผิดพลาดพร้อมรหัสคำขอภายใน แต่อย่าใส่ API key แสดงข้อความที่กระชับและช่วยให้ผู้ใช้แก้ปัญหาได้ แทนการเปิดเผยข้อมูลรับรองหรือข้อมูลคำขอภายใน

เอกสารครบถ้วนแล้ว

พัฒนาต่อด้วย GenderAPI

การใช้งานและโควตาติดตามเครดิตที่พร้อมใช้งาน →ราคาเปรียบเทียบแพ็กเกจเครดิต →

จัดการข้อผิดพลาดจาก API อย่างมั่นใจ

อ่านออบเจ็กต์ข้อผิดพลาด