ภาพรวมการยืนยันตัวตน
เลือกวิธีส่ง API key
คำขอทุกครั้งที่ต้องยืนยันตัวตนจำเป็นต้องใช้ GenderAPI key ที่ถูกต้อง โดยทั่วไปเราแนะนำให้ส่งผ่าน Authorization header เพื่อแยกข้อมูลรับรองออกจากข้อมูลของคำขอ
วิธีที่แนะนำ
Authorization header
กำหนด Authorization: Bearer YOUR_API_KEY และส่งเฉพาะพารามิเตอร์อินพุตในเนื้อหา JSON
Authorization
Bearer YOUR_API_KEYcURL
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"name":"Jiwon"}'JavaScript
fetch("https://api.genderapi.io/api", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_KEY"
},
body: JSON.stringify({ name: "Jiwon" })
});วิธีทางเลือก
เพิ่ม API key ในเนื้อหา JSON
เพิ่ม API key เป็นพร็อพเพอร์ตี key ไปพร้อมกับข้อมูลคำขอ ใช้วิธีนี้เฉพาะในโค้ดฝั่งเซิร์ฟเวอร์ ที่เชื่อถือได้เท่านั้น
cURL
curl -X POST "https://api.genderapi.io/api" \
-H "Content-Type: application/json" \
-d '{"name":"Jiwon","key":"YOUR_API_KEY"}'Python
import requests
response = requests.post(
"https://api.genderapi.io/api",
json={
"name": "Jiwon",
"key": "YOUR_API_KEY"
}
)
print(response.json())ความปลอดภัยของข้อมูลรับรอง
ปกป้อง API key ของคุณ
- เก็บ API key ในตัวแปรสภาพแวดล้อมของเซิร์ฟเวอร์หรือบริการจัดการความลับ
- อย่าเพิ่มคีย์ลงในระบบควบคุมเวอร์ชันหรือเปิดเผยผ่าน JavaScript ในเบราว์เซอร์
- นำข้อมูลรับรองออกจากล็อกของแอปพลิเคชัน พร็อกซี และระบบวิเคราะห์
- ใช้ HTTPS กับทุกคำขอ และเปลี่ยนคีย์ทันทีเมื่อสงสัยว่ารั่วไหล
เปรียบเทียบอย่างรวดเร็ว
ควรใช้วิธียืนยันตัวตนแบบใด
| วิธี | เหมาะสำหรับ | ตำแหน่งข้อมูลรับรอง |
|---|---|---|
| Bearer tokenแนะนำ | การเชื่อมต่อฝั่งเซิร์ฟเวอร์ส่วนใหญ่ | Authorization header |
| เนื้อหา JSON | การเชื่อมต่อ POST เดิม | key พร็อพเพอร์ตี |
ชนิดเนื้อหา POST: เมื่อส่งเนื้อหา JSON ให้กำหนด
Content-Type: application/jsonคู่มือถัดไป