Autentizace

Všechny API požadavky na GenderAPI vyžadují ověření. Svůj požadavek můžete autentizovat dvěma způsoby:

1. API klíč v POST těle jako parametr key
2. API klíč v hlavičce Authorization pomocí Bearer tokenu

1. API klíč v těle POST požadavku

Nejjednodušší způsob autentizace je vložit svůj API klíč do JSON těla POST požadavku jako pole key.

Například pro určení pohlaví jména "Alice":

Příklad cURL

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

Příklad 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));

Příklad 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 klíč v hlavičce Authorization (Bearer Token)

Pro lepší bezpečnost a přehlednější požadavky můžete zaslat svůj API klíč v hlavičce Authorization pomocí Bearer schématu. V tomto případě neuvádíte API klíč v těle JSON.

Do těla POST požadavku zadáváte pouze vstupní parametry (například name).

Například pro určení pohlaví jména "Alice":

Příklad cURL

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

Příklad 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));

Příklad 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())

Jakou metodu zvolit?

Obě metody autentizace jsou podporovány na všech API endpointech. Použití hlavičky Authorization je však bezpečnější, protože tím zabráníte, aby se váš API klíč objevil v těle požadavku a byl např. omylem zalogován.

Bez ohledu na zvolenou metodu vždy nastavte hlavičku Content-Type na application/json při odesílání POST požadavků.