Autentisering

Alle API-forespørsler til GenderAPI krever autentisering. Du kan autentisere forespørslene dine på to måter:

API-nøkkel i POST-body som key-parameter
API-nøkkel i Authorization-header ved bruk av Bearer-token

1. API-nøkkel i POST-body

Den enkleste måten å autentisere på, er å inkludere API-nøkkelen din som et felt kalt key i JSON-bodyen til POST-forespørselen din.

For eksempel, for å fastslå kjønn på navnet "Alice":

cURL-eksempel

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

JavaScript fetch-eksempel

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-eksempel

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-nøkkel i Authorization-header (Bearer Token)

For bedre sikkerhet og ryddigere forespørsler kan du sende API-nøkkelen din i Authorization-headeren ved hjelp av Bearer-skjemaet. Med denne metoden skal du ikke inkludere API-nøkkelen i JSON-bodyen.

I stedet legges kun dine inndata-parametere (som name) i POST-bodyen.

For eksempel, for å fastslå kjønn på navnet "Alice":

cURL-eksempel

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

JavaScript fetch-eksempel

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-eksempel

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

Valg mellom de to metodene

Begge autentiseringsmetodene støttes på alle API-endepunkter. Likevel er bruk av Authorization-headeren sikrere fordi den holder API-nøkkelen utenfor forespørsels-bodyen og hindrer at den logges ved en feil.

Uansett hvilken metode du bruker, må du alltid sette Content-Type-headeren til application/json når du sender POST-forespørsler.