Cách sử dụng cơ bản
Gửi yêu cầu GenderAPI đầu tiên
Gửi một giá trị đầu vào để nhận giới tính dự đoán, xác suất, quốc gia và thông tin sử dụng. Hãy bắt đầu bằng tên; dùng endpoint email hoặc username chuyên biệt khi đó là dữ liệu bạn có.
Thêm API key bằng tham số truy vấn key. Giữ key production ở phía máy chủ; không để lộ key riêng trong mã trình duyệt hoặc kho mã công khai.
Sử dụng hợp đồng GenderAPI hiện tại ở định dạng OpenAPI, Swagger hoặc Postman.
Giới tính từ tên
Tên riêng hoặc đầy đủ họ tên
Dùng endpoint cơ sở khi đầu vào là tên riêng hoặc đầy đủ họ tên.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"Tham số tùy chọn
| Tham số | Kiểu | Mô tả |
|---|---|---|
country | string | Mã quốc gia hai ký tự như VN hoặc US. |
askToAI | boolean | Khi là true, dùng AI fallback nếu tên không có trong cơ sở dữ liệu. |
forceToGenderize | boolean | Thử dự đoán cho đầu vào bất thường có thể không giống tên người. |
Giới tính từ email
Địa chỉ email
Email endpoint trích xuất tên có khả năng nhất từ địa chỉ trước khi thực hiện dự đoán giới tính.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=alice.smith%40example.com&country=VN&askToAI=true&key=YOUR_API_KEY"forceToGenderize không khả dụng cho endpoint này vì tên được trích xuất nội bộ.Giới tính từ tên người dùng
Tên người dùng mạng xã hội
Dùng endpoint này cho username, tài khoản và nickname có thể chứa một tên dễ nhận biết.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=VN&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"Phản hồi JSON
Hiểu phản hồi của GenderAPI
Cả ba endpoint sử dụng cùng cấu trúc phản hồi cốt lõi.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Alice",
"name": "alice",
"gender": "female",
"country": "US",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Các trường phản hồi
| Trường | Kiểu | Mô tả |
|---|---|---|
status | boolean | Cho biết yêu cầu có hoàn tất thành công hay không. |
used_credits | integer | Số credit được sử dụng cho yêu cầu này. |
remaining_credits | integer | Số credit còn lại sau yêu cầu. |
expires | integer | Thời điểm hết hạn gói dưới dạng UNIX timestamp. |
q | string | Tên, email hoặc tên người dùng ban đầu được truy vấn. |
name | string | Tên riêng đã chuẩn hóa hoặc được trích xuất. |
gender | string | Giới tính dự đoán: male, female hoặc "null". |
country | string | Mã quốc gia ISO 3166-1 alpha-2 có khả năng nhất. |
total_names | integer | Số bản ghi tên làm cơ sở cho dự đoán. |
probability | integer | Mức xác suất của dự đoán theo phần trăm. |
duration | string | Thời gian máy chủ xử lý yêu cầu. |
Luôn URL-encode giá trị đầu vào
Khoảng trắng và ký tự đặc biệt phải được HTTP client mã hóa. Ví dụ, dùng sparkling%20unicorn thay cho khoảng trắng thô.
Tiếp tục xây dựng