Godkendelse (Authentication)

Alle API-anmodninger til GenderAPI kræver godkendelse. Du kan godkende dine anmodninger på to måder:

1. API-nøgle i POST body som key-parameter
2. API-nøgle i Authorization-headeren ved brug af et Bearer token

1. API-nøgle i POST Body

Den nemmeste måde at godkende på er ved at inkludere din API-nøgle som et felt kaldet key i JSON-body’en af din POST-anmodning.

For eksempel, for at bestemme kønnet for 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øgle i Authorization Header (Bearer Token)

For bedre sikkerhed og renere anmodninger kan du sende din API-nøgle i Authorization-headeren ved hjælp af Bearer-schemet. Med denne metode skal du ikke inkludere API-nøglen i JSON-body’en.

I stedet placerer du kun dine inputparametre (såsom name) i POST-body’en.

For eksempel, for at bestemme kønnet for 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 mellem de to metoder

Begge godkendelsesmetoder understøttes på alle API-endpoints. Dog er brug af Authorization-headeren mere sikker, da den holder din API-nøgle ude af request-body’en og mindsker risikoen for at få den logget ved en fejl.

Uanset hvilken metode du bruger, skal du altid sætte Content-Type-headeren til application/json, når du laver POST-anmodninger.