Przegląd zapytania zbiorczego
Przetwarzaj do 100 imion
Wyślij tablicę data i odbierz wynik dla każdego rekordu. Dodaj id ze swojego systemu, aby niezawodnie powiązać każdą prognozę z rekordem źródłowym.
askToAI i forceToGenderize są niedostępne. Dla imion zapisanych alfabetem innym niż łaciński lub danych wymagających wsparcia AI użyj endpointu pojedynczego imienia.
Wymagane nagłówki HTTP
Autoryzuj zapytanie zbiorcze
Content-Typeapplication/jsonAuthorizationBearer YOUR_API_KEYTreść JSON zapytania
Parametry
| Pole | Typ | Status | Opis |
|---|---|---|---|
data | object[] | Wymagany | Tablica zawierająca od 1 do 100 rekordów imion. |
data[].name | string | Wymagany | Imię do analizy. |
data[].country | string | Opcjonalny | Kod kraju ISO 3166-1 alpha-2. Jeśli nie istnieje wynik krajowy, używany jest wynik globalny. |
data[].id | string | integer | Opcjonalny | Identyfikator rekordu z Twojego systemu, zwracany bez zmian w celu powiązania wyniku z wejściem. |
Jeśli dla przekazanego kraju nie ma dopasowania, GenderAPI zwraca dostępny wynik globalny. Używaj kodów ISO 3166-1 alpha-2, takich jak PL, IT lub US.
Dane zapytania
Zbuduj tablicę data
{
"data": [
{ "name": "Anna", "country": "PL", "id": "123" },
{ "name": "Andrea", "country": "IT", "id": "456" },
{ "name": "James", "country": "US", "id": "789" }
]
}Przykłady kodu
Wyślij zapytanie dla wielu imion
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":"Anna","country":"PL","id":"123"},{"name":"Andrea","country":"IT","id":"456"}]}'const data = [
{ name: "Anna", country: "PL", 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 })
});Odpowiedź 200
Powiąż wyniki ze swoimi rekordami
{
"status": true,
"used_credits": 2,
"remaining_credits": 7265,
"expires": 1717069765,
"names": [
{ "name": "anna", "q": "Anna", "gender": "female", "country": "PL", "total_names": 644, "probability": 88, "id": "123" },
{ "name": "andrea", "q": "Andrea", "gender": "male", "country": "IT", "total_names": 13537, "probability": 98, "id": "456" }
],
"duration": "5ms"
}Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status | boolean | Informuje, czy zapytanie zbiorcze zakończyło się powodzeniem. |
used_credits | integer | Kredyty wykorzystane dla wszystkich przesłanych imion. |
remaining_credits | integer | Kredyty dostępne po zapytaniu. |
expires | integer | Czas wygaśnięcia pakietu jako znacznik UNIX. |
names | object[] | Uporządkowana kolekcja wyników prognozy. |
names[].name | string | Znormalizowane imię użyte do prognozy. |
names[].q | string | Oryginalne imię przesłane w zapytaniu. |
names[].gender | string | null | Przewidywana wartość: male, female albo null. |
names[].country | string | Kod kraju uwzględniony dla danego wyniku. |
names[].total_names | integer | Liczba próbek wspierających dany wynik. |
names[].probability | integer | Poziom pewności prognozy w procentach. |
names[].id | string | integer | Identyfikator wejściowy zwrócony do powiązania rekordów. |
duration | string | Łączny czas przetwarzania po stronie serwera. |
Nie przekraczaj 100 rekordów w zapytaniu
Sprawdź tablicę przed wysłaniem i użyj unikalnego id, aby jednoznacznie powiązać rekordy. Większe zbiory podziel na partie zawierające maksymalnie 100 imion.
Następny przewodnik