การใช้งานพื้นฐาน

GenderAPI ช่วยให้คุณสามารถระบุเพศของบุคคลได้โดยใช้ข้อมูลประเภทต่างๆ คุณสามารถวิเคราะห์ชื่อโดยตรง หรือดึงชื่อจากที่อยู่อีเมลและชื่อผู้ใช้ก็ได้ นี่คือวิธีเริ่มต้นใช้งาน:

1. ระบุเพศจากชื่อ

ส่งชื่อไปยัง endpoint ต่อไปนี้: 

https://api.genderapi.io/api

ตัวอย่าง: 

curl "https://api.genderapi.io/api?name=Alice&key=YOUR_API_KEY"

คุณยังสามารถเพิ่มพารามิเตอร์เพิ่มเติมได้:

  • country: ระบุรหัสประเทศสองตัวอักษร ( ISO 3166-1 alpha-2 ) เพื่อเพิ่มความแม่นยำในการทำนาย เช่น country=TH สำหรับประเทศไทย
  • askToAI: ถ้ากำหนดเป็น true API จะใช้ AI เพื่อประเมินเพศเมื่อไม่พบชื่อนั้นในฐานข้อมูล
  • forceToGenderize: ถ้ากำหนดเป็น true API จะพยายามคาดเดาเพศแม้ว่าข้อมูลที่ส่งมาอาจไม่ใช่ชื่อจริง เช่น ชื่อเล่นหรือชื่อแฟนตาซี เช่น sparkling unicorn หรือ mystic warrior ซึ่งมีประโยชน์ในการวิเคราะห์ชื่อผู้ใช้ แต่ผลลัพธ์อาจไม่แม่นยำมากนัก หมายเหตุ: พารามิเตอร์นี้ไม่สามารถใช้กับ endpoint ของอีเมลได้

ตัวอย่างที่ใช้พารามิเตอร์: 

curl "https://api.genderapi.io/api?name=sparkling%20unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

2. ระบุเพศจากที่อยู่อีเมล

ใช้ endpoint นี้เมื่อคุณมีแค่อีเมล: 

https://api.genderapi.io/api/email

ตัวอย่าง: 

curl "https://api.genderapi.io/api/email?email=alice.smith@example.com&country=TH&askToAI=true&key=YOUR_API_KEY"

หมายเหตุ: พารามิเตอร์ forceToGenderize ไม่สามารถใช้กับ endpoint นี้ได้ เนื่องจากระบบจะดึงชื่อจากอีเมลโดยอัตโนมัติ


3. ระบุเพศจากชื่อผู้ใช้

สำหรับชื่อผู้ใช้หรือชื่อเล่น ให้ใช้: 

https://api.genderapi.io/api/username

ตัวอย่าง: 

curl "https://api.genderapi.io/api/username?username=sparkling_unicorn&country=US&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"

พารามิเตอร์ forceToGenderize มีประโยชน์มากในกรณีนี้ เพราะชื่อผู้ใช้มักจะไม่ได้เป็นชื่อจริง ระบบจะพยายามทำนายเพศแม้ว่าข้อมูลจะไม่ใช่ชื่อบุคคลทั่วไป

ทุกวิธีรองรับทั้งการส่งแบบเดี่ยวและแบบกลุ่ม ดูรายละเอียดเพิ่มเติมได้จากเมนูด้านซ้าย


✅ การตอบกลับจาก API

ตัวอย่าง JSON ที่ตอบกลับจากทุก endpoint: 

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 325,
  "probability": 98,
  "duration": "4ms"
}

คำอธิบายฟิลด์ในผลลัพธ์

ฟิลด์ ประเภท คำอธิบาย
status Boolean true หมายถึงคำขอสำเร็จ false ให้ตรวจสอบ error
used_credits Integer จำนวนเครดิตที่ใช้ในการเรียกครั้งนี้
remaining_credits Integer เครดิตที่เหลืออยู่ในบัญชีของคุณ
expires Integer (timestamp) วันหมดอายุของแพ็กเกจแบบ UNIX timestamp (หน่วยวินาที)
q String ค่าที่คุณส่งเข้ามา (ชื่อ อีเมล หรือชื่อผู้ใช้)
name String ชื่อที่ระบบดึงหรือระบุได้
gender Enum[String] เพศที่คาดการณ์ได้: male, female, หรือ null
country Enum[String] รหัสประเทศที่น่าจะเป็นไปได้มากที่สุด เช่น US, DE
total_names Integer จำนวนตัวอย่างชื่อที่ใช้ในการคาดการณ์
probability Integer เปอร์เซ็นต์ความน่าจะเป็นของผลการทำนายเพศ (เช่น 50-100)
duration String ระยะเวลาในการประมวลผล (เช่น 4ms)
คำเตือน: หากค่าที่คุณป้อนมีช่องว่างหรืออักขระพิเศษ (เช่น sparkling unicorn) โปรด URL-encode ค่านั้นก่อนทำการส่งแบบ GET ไม่เช่นนั้นคำขออาจล้มเหลว หรือพารามิเตอร์อื่นอาจถูกตีความผิดพลาดโดยภาษาโปรแกรมหรือไลบรารี HTTP ของคุณ 
curl "https://api.genderapi.io/api?name=sparkling unicorn&key=YOUR_API_KEY"
ควรใช้: 
curl "https://api.genderapi.io/api?name=sparkling%20unicorn&key=YOUR_API_KEY"
หรือใช้ฟังก์ชันสำหรับ URL-encoding ที่เหมาะสมกับภาษาของคุณ