Cấu trúc phản hồi
Đọc đối tượng lỗi
Khi yêu cầu thất bại, phản hồi JSON trả status là false. Dùng errno dạng số cho logic ứng dụng và giữ errmsg cho log hoặc chẩn đoán dễ đọc.
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}errno, không dựa vào nguyên văn errmsg. Cách này giúp tích hợp ổn định nếu phần mô tả thay đổi sau này.Bảng tra cứu đầy đủ
Mã lỗi GenderAPI
Các giá trị sau khớp với tài liệu GenderAPI công khai hiện tại. Hãy khắc phục nguyên nhân trước khi gửi lại yêu cầu.
access deniedYêu cầu đến từ địa chỉ IP hoặc referrer không được phép.
invalid country codeGiá trị quốc gia không phải mã ISO 3166-1 alpha-2 được hỗ trợ.
name not set || email not set || username not setYêu cầu thiếu tham số name, email hoặc username bắt buộc.
too many names || too many emails || too many usernamesYêu cầu vượt giới hạn lô: 100 tên, 50 email hoặc 50 username.
query limit reachedAPI key không còn credit.
invalid or missing keyAPI key bị thiếu hoặc không được tìm thấy.
API key has expiredGói liên kết với API key đã hết hạn.
Hướng dẫn xử lý
Xử lý lỗi an toàn và tránh thử lại mù quáng
Kiểm tra đầu vào trước
Loại bỏ dữ liệu thiếu, mã quốc gia sai và lô quá lớn trước khi gửi đến API.
Bảo vệ thông tin xác thực
Giữ API key trên máy chủ và che key trong log ứng dụng, đầu ra trình duyệt và ảnh hỗ trợ.
Chỉ thử lại khi phù hợp
Các lỗi này cần sửa yêu cầu hoặc xử lý tài khoản. Gửi lại nguyên yêu cầu sẽ không giải quyết được lỗi.
type GenderApiError = {
status: false;
errno: number;
errmsg: string;
};
if (response.status === false) {
handleGenderApiError(response.errno, response.errmsg);
}Giữ thông tin chẩn đoán ở chế độ riêng tư
Ghi số lỗi cùng mã yêu cầu nội bộ nhưng không bao giờ ghi API key. Hiển thị thông báo ngắn gọn, có thể hành động thay vì để lộ thông tin xác thực hoặc dữ liệu nội bộ.
Hoàn tất tài liệu