Uwierzytelnianie (Authentication)

Wszystkie żądania API do GenderAPI wymagają uwierzytelnienia. Możesz uwierzytelnić swoje żądania na dwa sposoby:

1. API Key w ciele POST jako parametr key
2. API Key w nagłówku Authorization używając Bearer token

1. API Key w ciele POST

Najprostszy sposób uwierzytelnienia polega na umieszczeniu swojego API Key w polu o nazwie key w JSON body żądania POST.

Na przykład, aby określić płeć dla imienia „Alice”:

Przykład z użyciem cURL

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

Przykład z użyciem 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));

Przykład z użyciem 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. API Key w nagłówku Authorization (Bearer Token)

Dla lepszego bezpieczeństwa i czystszych żądań możesz przesłać swój API Key w nagłówku Authorization, używając schematu Bearer. W tej metodzie nie umieszczasz klucza API w JSON body.

Zamiast tego, w body POST znajdują się wyłącznie parametry wejściowe (takie jak name).

Na przykład, aby określić płeć dla imienia „Alice”:

Przykład z użyciem cURL

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

Przykład z użyciem 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));

Przykład z użyciem 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())

Wybór między dwiema metodami

Obie metody uwierzytelniania są obsługiwane na wszystkich endpointach API. Jednak użycie nagłówka Authorization jest bezpieczniejsze, ponieważ pozwala trzymać Twój API Key poza ciałem żądania i zapobiega przypadkowemu zapisaniu go w logach.

Niezależnie od wybranej metody, zawsze ustawiaj nagłówek Content-Type na application/json podczas wysyłania żądań POST.