Základní použití
Odešlete svůj první požadavek Gender API
Odešlete jednu vstupní hodnotu a získejte odhad pohlaví, pravděpodobnost, zemi a údaje o spotřebě. Začněte jménem; pokud máte e-mail nebo uživatelské jméno, použijte příslušný specializovaný endpoint.
API klíč přidejte pomocí parametru key. Produkční klíče uchovávejte na serveru a nikdy je nezveřejňujte v kódu prohlížeče ani ve veřejném repozitáři.
Použijte aktuální kontrakt GenderAPI ve formátu OpenAPI, Swagger nebo Postman.
Pohlaví podle jména
Křestní nebo celé jméno
Základní endpoint použijte, když je vstupem křestní nebo celé jméno.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Tereza&country=CZ&key=YOUR_API_KEY"Volitelné parametry
| Parametr | Typ | Popis |
|---|---|---|
country | string | Dvoupísmenný kód země, například CZ nebo US. |
askToAI | boolean | Při hodnotě true použije podporu AI, pokud jméno není nalezeno v databázi. |
forceToGenderize | boolean | Pokusí se o odhad u neobvyklých vstupů, které nemusí vypadat jako osobní jména. |
Pohlaví podle e-mailu
E-mailová adresa
E-mailový endpoint nejprve z adresy extrahuje pravděpodobné jméno a poté provede odhad pohlaví.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=tereza.novakova%40example.com&country=CZ&askToAI=true&key=YOUR_API_KEY"forceToGenderize není pro tento endpoint dostupný, protože se jméno extrahuje interně.Pohlaví podle uživatelského jména
Uživatelské jméno na sociální síti
Tento endpoint použijte pro uživatelská jména, identifikátory a přezdívky, které mohou obsahovat rozpoznatelné jméno.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=tereza_n&country=CZ&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"Odpověď JSON
Porozumění odpovědi GenderAPI
Všechny tři endpointy používají stejnou základní strukturu odpovědi.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Tereza",
"name": "tereza",
"gender": "female",
"country": "CZ",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Pole odpovědi
| Pole | Typ | Popis |
|---|---|---|
status | boolean | Určuje, zda byl požadavek úspěšně zpracován. |
used_credits | integer | Počet kreditů spotřebovaných tímto požadavkem. |
remaining_credits | integer | Počet kreditů zbývajících po zpracování požadavku. |
expires | integer | Čas vypršení balíčku jako časové razítko UNIX. |
q | string | Původní dotaz obsahující jméno, e-mail nebo uživatelské jméno. |
name | string | Normalizované nebo extrahované křestní jméno. |
gender | string | Odhadované pohlaví: male, female nebo "null". |
country | string | Nejpravděpodobnější dvoupísmenný kód země ISO 3166-1 alpha-2. |
total_names | integer | Počet záznamů jmen použitých pro odhad. |
probability | integer | Míra spolehlivosti odhadu v procentech. |
duration | string | Doba zpracování požadavku na serveru. |
Vstupní hodnoty vždy kódujte pro URL
Mezery a speciální znaky musí zakódovat váš HTTP klient. Místo nezakódované mezery použijte napříkladtereza%20novakova.
Pokračujte v integraci