API-turvallisuus

Tunnista Gender API -pyynnöt

Käytä yksityistä API-avainta Bearer-tokenina tai lisää se palvelimelta lähetettävään JSON-pyyntöön.

HTTPS vaaditaanKaksi tuettua menetelmää

Tunnistautumisen yleiskatsaus

Valitse, miten API-avain lähetetään

Kaikki tunnistetut pyynnöt edellyttävät voimassa olevaa GenderAPI-avainta. Authorization-header on suositeltu oletustapa, koska se pitää tunnistetiedot erillään pyynnön varsinaisesta datasta.

Suositeltu

Authorization-header

Bearer-token

Aseta Authorization: Bearer YOUR_API_KEY ja lähetä JSON-rungossa vain syöteparametrit.

AuthorizationBearer YOUR_API_KEY
cURL
curl -X POST "https://api.genderapi.io/api" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"name":"Emilia"}'
JavaScript
fetch("https://api.genderapi.io/api", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({ name: "Emilia" })
});

Vaihtoehto

API-avain JSON-rungossa

POST-body

Lisää avain key-ominaisuutena pyynnön datan yhteyteen. Käytä tätä menetelmää vain palvelimen luotetusta koodista.

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

response = requests.post(
  "https://api.genderapi.io/api",
  json={
    "name": "Emilia",
    "key": "YOUR_API_KEY"
  }
)
print(response.json())

Tunnistetietojen turvallisuus

Suojaa API-avaimesi

  • Säilytä avaimet palvelimen ympäristömuuttujissa tai salaisuuksien hallintapalvelussa.
  • Älä koskaan tallenna avainta versionhallintaan tai paljasta sitä selaimen JavaScriptissä.
  • Poista tunnistetiedot sovellus-, välityspalvelin- ja analytiikkalokeista.
  • Käytä HTTPS-yhteyttä kaikissa pyynnöissä ja vaihda avain, jos se on voinut vuotaa.

Nopea vertailu

Kumpaa menetelmää kannattaa käyttää?

MenetelmäSopii parhaitenTunnistetietojen sijainti
Bearer-tokenSuositeltuUseimmat palvelinintegraatiotAuthorization-header
JSON-runkoNykyiset POST-integraatiotkey-ominaisuus
POST-pyynnön sisältötyyppi: Aseta Content-Type: application/json, kun lähetät JSON-rungon.

Seuraava opas

Lähetä yksittäinen nimikysely

Sukupuoli nimestäYksittäisen kyselyn parametrit ja vastaus →AsiakaskirjastotTakaisin virallisiin SDK-paketteihin →