Přehled hromadného požadavku
Zpracujte až 100 jmen
Odešlete pole data a získejte jeden výsledek pro každý záznam. Přidejte id ze svého systému, abyste každý odhad spolehlivě spojili se zdrojovým záznamem.
Parametry askToAI a forceToGenderize nejsou dostupné. Pro jména v nelatinkovém písmu nebo vstupy vyžadující podporu AI použijte endpoint pro jedno jméno.
Povinné HTTP hlavičky
Autorizujte hromadný požadavek
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTělo požadavku JSON
Parametry
| Pole | Typ | Požadavek | Popis |
|---|---|---|---|
data | object[] | Povinné | Pole obsahující 1 až 100 záznamů jmen. |
data[].name | string | Povinné | Křestní jméno k analýze. |
data[].country | string | Volitelné | Kód země ISO 3166-1 alpha-2. Pokud pro zemi neexistuje výsledek, použije se globální výsledek. |
data[].id | string | integer | Volitelné | Váš identifikátor záznamu; vrací se beze změny, aby bylo možné přiřadit výsledky ke vstupním záznamům. |
Pokud pro zadanou zemi neexistuje shoda, GenderAPI vrátí dostupný globální výsledek. Používejte hodnoty ISO 3166-1 alpha-2, například CZ, DE nebo US.
Data požadavku
Sestavte pole data
{
"data": [
{ "name": "Andrea", "country": "DE", "id": "123" },
{ "name": "andrea", "country": "IT", "id": "456" },
{ "name": "james", "country": "US", "id": "789" }
]
}Příklady kódu
Odešlete požadavek s více jmény
curl -X POST "https://api.genderapi.io/api/name/multi/country" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"data":[{"name":"Andrea","country":"DE","id":"123"},{"name":"andrea","country":"IT","id":"456"}]}'const data = [
{ name: "Andrea", country: "DE", id: "123" },
{ name: "andrea", country: "IT", id: "456" }
];
const response = await fetch("https://api.genderapi.io/api/name/multi/country", {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer YOUR_API_KEY" },
body: JSON.stringify({ data })
});Odpověď 200
Propojte výsledky se svými záznamy
{
"status": true,
"used_credits": 3,
"remaining_credits": 7265,
"expires": 1717069765,
"names": [
{ "name": "andrea", "q": "Andrea", "gender": "female", "country": "DE", "total_names": 644, "probability": 88, "id": "123" },
{ "name": "andrea", "q": "andrea", "gender": "male", "country": "IT", "total_names": 13537, "probability": 98, "id": "456" }
],
"duration": "5ms"
}Pole odpovědi
| Pole | Typ | Popis |
|---|---|---|
status | boolean | Určuje, zda byl hromadný požadavek úspěšně zpracován. |
used_credits | integer | Počet kreditů spotřebovaných všemi odeslanými jmény. |
remaining_credits | integer | Počet kreditů dostupných po požadavku. |
expires | integer | Čas vypršení balíčku jako časové razítko UNIX. |
names | object[] | Seřazená kolekce výsledků odhadu pro jména. |
names[].name | string | Normalizované jméno použité pro odhad. |
names[].q | string | Původní jméno odeslané v požadavku. |
names[].gender | string | null | Odhadovaná hodnota: male, female nebo null. |
names[].country | string | Kód země zohledněný pro tento výsledek. |
names[].total_names | integer | Počet vzorků podporujících tento výsledek. |
names[].probability | integer | Míra spolehlivosti odhadu v procentech. |
names[].id | string | integer | Vstupní identifikátor vrácený pro propojení záznamů. |
duration | string | Celková doba zpracování na serveru. |
Omezte každý požadavek na 100 záznamů
Před odesláním pole ověřte a pro jednoznačné propojení záznamů používejte unikátní id. Větší datové sady rozdělte do dávek po nejvýše 100 jménech.
Další průvodce