प्रमाणीकरण (Authentication)

GenderAPI के लिए सभी API अनुरोधों के लिए प्रमाणीकरण आवश्यक है। आप दो तरीकों से अपने अनुरोध प्रमाणित कर सकते हैं:

  1. POST बॉडी में key पैरामीटर के रूप में API Key
  2. Authorization हेडर में API Key Bearer token का उपयोग करते हुए

1. POST बॉडी में API Key

प्रमाणित करने का सबसे सरल तरीका है, अपनी API Key को key नाम के फील्ड के रूप में JSON बॉडी में शामिल करना।

उदाहरण के लिए, नाम "Alice" का जेंडर निर्धारित करने के लिए:


cURL उदाहरण

curl -X POST "https://api.genderapi.io/api" \
     -H "Content-Type: application/json" \
     -d '{"name": "Alice", "key": "YOUR_API_KEY"}'

JavaScript fetch उदाहरण

fetch("https://api.genderapi.io/api", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Alice",
    key: "YOUR_API_KEY"
  })
})
.then(response => response.json())
.then(data => console.log(data));

Python requests उदाहरण

import requests

url = "https://api.genderapi.io/api"

payload = {
    "name": "Alice",
    "key": "YOUR_API_KEY"
}

headers = {
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

2. Authorization हेडर में API Key (Bearer Token)

बेहतर सुरक्षा और साफ-सुथरे अनुरोधों के लिए, आप अपनी API Key को Authorization हेडर में Bearer स्कीम के तहत भेज सकते हैं। इस विधि में, आप JSON बॉडी में API Key शामिल नहीं करते।

इसके बजाय, केवल आपके इनपुट पैरामीटर (जैसे name) POST बॉडी में होते हैं।

उदाहरण के लिए, नाम "Alice" का जेंडर निर्धारित करने के लिए:


cURL उदाहरण

curl -X POST "https://api.genderapi.io/api" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{"name": "Alice"}'

JavaScript fetch उदाहरण

fetch("https://api.genderapi.io/api", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({
    name: "Alice"
  })
})
.then(response => response.json())
.then(data => console.log(data));

Python requests उदाहरण

import requests

url = "https://api.genderapi.io/api"

payload = {
    "name": "Alice"
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

दोनों तरीकों में से किसी एक को चुनना

दोनों प्रमाणीकरण विधियां सभी API endpoints पर समर्थित हैं। हालांकि, Authorization हेडर का उपयोग करना अधिक सुरक्षित है क्योंकि यह आपकी API Key को अनुरोध के बॉडी से बाहर रखता है और गलती से इसे लॉग होने से बचाता है।

चाहे आप कोई भी तरीका चुनें, POST अनुरोध भेजते समय हमेशा Content-Type हेडर को application/json पर सेट करें।