Peruskäyttö
Tee ensimmäinen Gender API -kyselysi
Lähetä yksi syötearvo ja saat arvioidun sukupuolen, todennäköisyyden, maan sekä käyttötiedot. Aloita nimestä ja käytä erillistä sähköposti- tai käyttäjänimirajapintaa, kun aineistosi sisältää kyseisen arvon.
Lisää API-avain kyselyparametrilla key. Säilytä tuotantoavaimet palvelimella äläkä koskaan julkaise yksityistä avainta selainkoodissa tai julkisessa koodivarastossa.
Käytä ajantasaista GenderAPI-sopimusta OpenAPI-, Swagger- tai Postman-muodossa.
Sukupuoli nimestä
Etunimi tai koko nimi
Käytä perusrajapintaa, kun syöte on etunimi tai koko nimi.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Emilia&country=FI&key=YOUR_API_KEY"Valinnaiset parametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
country | string | Kaksikirjaiminen maatunnus, kuten FI tai US. |
askToAI | boolean | Arvolla true pyytää tekoälyvarmistusta, jos nimeä ei löydy tietokannasta. |
forceToGenderize | boolean | Yrittää arviota epätavallisille syötteille, jotka eivät välttämättä näytä henkilönnimiltä. |
Sukupuoli sähköpostista
Sähköpostiosoite
Sähköpostirajapinta poimii osoitteesta todennäköisen nimen ennen sukupuolen arviointia.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=emilia.korhonen%40example.com&country=FI&askToAI=true&key=YOUR_API_KEY"forceToGenderize ei ole käytettävissä tässä rajapinnassa, koska nimi poimitaan sisäisesti.Sukupuoli käyttäjänimestä
Sosiaalisen median käyttäjänimi
Käytä tätä rajapintaa käyttäjänimille, tunnuksille ja nimimerkeille, jotka voivat sisältää tunnistettavan nimen.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=emilia_k&country=FI&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"JSON-vastaus
GenderAPI-vastauksen tulkitseminen
Kaikki kolme rajapintaa käyttävät samaa vastauksen perusrakennetta.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Emilia",
"name": "emilia",
"gender": "female",
"country": "FI",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Vastauskentät
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status | boolean | Ilmaisee, onnistuiko kyselyn käsittely. |
used_credits | integer | Tämän kyselyn kuluttamien krediittien määrä. |
remaining_credits | integer | Kyselyn jälkeen jäljellä olevat krediitit. |
expires | integer | Paketin vanhenemisaika UNIX-aikaleimana. |
q | string | Alkuperäinen nimi-, sähköposti- tai käyttäjänimikysely. |
name | string | Normalisoitu tai poimittu etunimi. |
gender | string | Arvioitu sukupuoli: male, female tai "null". |
country | string | Todennäköisin kaksikirjaiminen ISO 3166-1 alpha-2 -maatunnus. |
total_names | integer | Arvion taustalla olevien nimitietueiden määrä. |
probability | integer | Arvion todennäköisyys prosentteina. |
duration | string | Kyselyn käsittelyaika palvelimella. |
URL-koodaa syötearvot aina
HTTP-asiakkaan on koodattava välilyönnit ja erikoismerkit. Käytä esimerkiksi arvoa emilia%20korhonen raakaa välilyöntiä sisältävän arvon sijaan.
Jatka toteutusta