Autentisering (Authentication)

Alla API-förfrågningar till GenderAPI kräver autentisering. Du kan autentisera dina förfrågningar på två sätt:

API-nyckel i POST-body som parametern key
API-nyckel i Authorization-headern med ett Bearer token

1. API-nyckel i POST-body

Det enklaste sättet att autentisera är att inkludera din API-nyckel som ett fält som heter key i JSON-body:n i din POST-förfrågan.

Till exempel, för att avgöra könet på namnet ”Alice”:

Exempel med cURL

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

Exempel med 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));

Exempel med 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-nyckel i Authorization-header (Bearer Token)

För bättre säkerhet och renare förfrågningar kan du skicka din API-nyckel i Authorization-headern med Bearer-schemat. I denna metod ska du inte inkludera API-nyckeln i JSON-body:n.

Istället skickar du endast dina inparametrar (såsom name) i POST-body:n.

Till exempel, för att avgöra könet på namnet ”Alice”:

Exempel med cURL

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

Exempel med 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));

Exempel med 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())

Att välja mellan de två metoderna

Båda autentiseringsmetoderna stöds på alla API-endpoints. Dock är användning av Authorization-headern säkrare eftersom den håller din API-nyckel utanför request-body:n och förhindrar att den oavsiktligt loggas.

Oavsett vilken metod du väljer bör du alltid sätta headern Content-Type till application/json när du gör POST-förfrågningar.