Määritä sukupuoli sähköpostista – Yksittäinen pyyntö

Get Gender by Email -päätepisteen avulla voit määrittää henkilön sukupuolen analysoimalla hänen sähköpostiosoitteensa. Kaikki parametrit lähetetään POST-pyynnössä JSON-muodossa. Sinun täytyy tunnistautua käyttämällä Bearer-tunnusta Authorization-otsikossa.

Pyyntöosoite

POST https://api.genderapi.io/api/email

Vaaditut HTTP-otsikot

  • Content-Type: application/json
  • Authorization: Bearer YOUR_API_KEY

Pyyntörungon parametrit

Parametri Tyyppi Pakollinen Kuvaus
email Merkkijono Kyllä Sähköpostiosoite analysoitavaksi. API poimii todennäköisen etunimen sähköpostista ennen sukupuolen määritystä.
country Merkkijono Ei Kaksikirjaiminen maakoodi (ISO 3166-1 alpha-2) parantamaan ennusteen tarkkuutta. Esimerkki: TR Turkille.
askToAI Boolean Ei Jos asetetaan arvoksi true, API kysyy tekoälymallilta sukupuolen määritystä, jos poimittua nimeä ei löydy tietokannasta.

Esimerkkipyynnöt


cURL-esimerkki

curl -X POST "https://api.genderapi.io/api/email" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{"email": "michael.smith@example.com", "country": "US", "askToAI": true}'

PHP cURL -esimerkki

<?php
$url = "https://api.genderapi.io/api/email";

$data = array(
    "email" => "michael.smith@example.com",
    "country" => "US",
    "askToAI" => true
);

$payload = json_encode($data);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "Content-Type: application/json",
    "Authorization: Bearer YOUR_API_KEY"
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

JavaScript fetch -esimerkki

fetch("https://api.genderapi.io/api/email", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
  body: JSON.stringify({
    email: "michael.smith@example.com",
    country: "US",
    askToAI: true
  })
})
.then(response => response.json())
.then(data => console.log(data));

Python requests -esimerkki

import requests

url = "https://api.genderapi.io/api/email"

payload = {
    "email": "michael.smith@example.com",
    "country": "US",
    "askToAI": True
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

Esimerkki JSON-vastauksesta

{
  "status": true,
  "used_credits": 1,
  "remaining_credits": 4999,
  "expires": 1743659200,
  "q": "michael.smith@example.com",
  "name": "Michael",
  "gender": "male",
  "country": "US",
  "total_names": 10345,
  "probability": 97,
  "duration": "5ms"
}

Vasteen kentät

Kenttä Tyyppi Kuvaus
status Boolean Kertoo, onnistuiko pyyntö.
used_credits Kokonaisluku Tähän pyyntöön käytettyjen krediittien määrä.
remaining_credits Kokonaisluku Käyttäjätilillesi jääneet krediitit pyynnön jälkeen.
expires Kokonaisluku (timestamp) Paketin vanhenemispäivä UNIX-aikaleimana.
q Merkkijono Syöttämäsi sähköposti (kysely).
name Merkkijono Sähköpostista poimittu etunimi.
gender Enum[String] Ennustettu sukupuoli. Mahdolliset arvot: male, female tai null.
country Merkkijono Maa, jota ennusteessa on käytetty.
total_names Kokonaisluku Kuinka monesta nimestä ennuste on laskettu.
probability Kokonaisluku Varmuusprosentti sukupuoliennusteessa.
duration Merkkijono Pyynnön käsittelyaika (esim. 5ms).