Massakyselyn yleiskatsaus
Käsittele jopa 50 sähköpostiosoitetta
Lähetä data-luettelo. GenderAPI poimii jokaisesta osoitteesta todennäköisen nimen ja palauttaa vastaavan ennusteen. Valinnainen id yhdistää tuloksen yksiselitteisesti järjestelmäsi tietueeseen.
Pakolliset HTTP-headerit
Valtuuta massakysely
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYPyynnön JSON-runko
Parametrit
| Kenttä | Tyyppi | Vaatimus | Kuvaus |
|---|---|---|---|
data | object[] | Pakollinen | Luettelo, jossa on 1–50 sähköpostitietuetta. |
data[].email | string | Pakollinen | Sähköpostiosoite, josta GenderAPI poimii todennäköisen etunimen. |
data[].country | string | Valinnainen | Alueellisena kontekstina käytettävä ISO 3166-1 alpha-2 -maakoodi. |
data[].id | string | integer | Valinnainen | Oma tietuetunnuksesi palautetaan muuttamattomana vastaavan tuloksen mukana. |
Käytä jokaiselle kohteelle yksilöllistä id-arvoa. GenderAPI palauttaa sen tuloksen mukana, joten voit päivittää oikean tietueen turvautumatta pelkkään sijaintiin luettelossa.
Pyynnön hyötykuorma
Muodosta sähköpostiluettelo
{
"data": [
{ "email": "emilia.korhonen@example.com", "country": "FI", "id": "123" },
{ "email": "mikael.lindberg@example.se", "country": "SE", "id": "456" },
{ "email": "sofia.niemi@example.com", "country": "FI", "id": "789" }
]
}Koodiesimerkit
Lähetä usean sähköpostiosoitteen kysely
curl -X POST "https://api.genderapi.io/api/email/multi/country" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"data":[{"email":"emilia.korhonen@example.com","country":"FI","id":"123"},{"email":"sofia.niemi@example.com","country":"FI","id":"789"}]}'const data = [
{ email: "emilia.korhonen@example.com", country: "FI", id: "123" },
{ email: "sofia.niemi@example.com", country: "FI", id: "789" }
];
const response = await fetch("https://api.genderapi.io/api/email/multi/country", {
method: "POST", headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ data })
});200-vastaus
Poimitut nimet ja ennusteet
{
"status": true, "used_credits": 3, "remaining_credits": 7265,
"expires": 1717069765,
"names": [
{ "name": "Emilia", "q": "emilia.korhonen@example.com", "gender": "female", "country": "FI", "total_names": 644, "probability": 88, "id": "123" },
{ "name": "Sofia", "q": "sofia.niemi@example.com", "gender": "female", "country": "FI", "total_names": 45274, "probability": 100, "id": "789" }
], "duration": "5ms"
}Vastauskentät
| Kenttä | Tyyppi | Kuvaus |
|---|---|---|
status | boolean | Suoritettiinko massakysely ilman virheitä. |
used_credits | integer | Kaikkien lähetettyjen sähköpostiosoitteiden käyttämät krediitit. |
remaining_credits | integer | Pyynnön jälkeen käytettävissä olevat krediitit. |
expires | integer | Paketin vanhenemisaika UNIX-aikaleimana. |
names | object[] | Järjestetty tulosluettelo lähetetyille sähköpostiosoitteille. |
names[].name | string | Sähköpostiosoitteesta poimittu etunimi. |
names[].q | string | Pyynnössä lähetetty alkuperäinen sähköpostiosoite. |
names[].gender | string | null | Ennustettu arvo: male, female tai null. |
names[].country | string | Tuloksessa huomioitu maakoodi. |
names[].total_names | integer | Tulosta tukevien nimiesiintymien määrä. |
names[].probability | integer | Ennusteen luottamus prosentteina. |
names[].id | string | integer | Tietueiden yhdistämistä varten palautettava syötetunnus. |
duration | string | Palvelimen kokonaiskäsittelyaika. |
Rajoita kukin kysely 50 tietueeseen
Tarkista jokainen osoite ja jaa suuremmat aineistot enintään 50 tietueen eriin. Tarkista name- ja probability-arvot ennen tuloksen käyttämistä. Sähköpostikyselyjä ei tallenneta.
Seuraava opas