Co může prozradit e-mailová adresa?
Pošlete syntakticky platnou e-mailovou adresu s type: email. GenderAPI.io hledá jmenný signál v části před @ a potom vrátí strukturovaný odhad. Neověřuje schránku, neidentifikuje jejího vlastníka ani neurčuje genderovou identitu této osoby.
Shoda v datové sadě získává kandidáty z částí adresy a může zkoušet omezený počet podřetězců. Režim přezdívek zachovává shodu celých částí, ale tyto kandidáty z podřetězců nepřidává. Pokud se shoduje více záznamů, vybere se kandidát s nejvyšším uloženým celkovým počtem; nemusí to být zamýšlené křestní jméno. Než získané jméno použijete v záznamu kontaktu, zkontrolujte data.name a data.match.
| Příklad vstupu | Jak ho vyložit |
|---|---|
alice.smith@example.com | Lokální část obsahuje možné části jména. Shoda je možná, ale samotný vstup neurčuje, který kandidát bude vybrán. |
alice+news@example.com | Vyhledávání v datové sadě pro své kandidáty odstraní příponu za znakem plus. AI dostane pokyn ji ignorovat, obdrží však odeslanou hodnotu. |
support@example.com | Rolová adresa neposkytuje spolehlivý signál osobního jména. Celé sdílené schránce nepřiřazujte pohlaví jedné osoby. |
prenses@example.com | Volitelné forceToGenderize umožní pokus podle významu přezdívky, pokud datová sada nepřinese výsledek. V tomto režimu skutečné jméno není potřeba. |
not-an-email | Neplatná syntaxe vrátí chybu validace, nikoli úspěšný neznámý výsledek. |
Odešlete vyhledání e-mailu ze své aplikace
Příklad používá váš stávající API klíč v hlavičce Bearer a explicitní fallback. Ukázkovou adresu nahraďte vstupem, který smíte zpracovávat. country uvádějte jen tehdy, když máte relevantní kontext; e-mailová doména neurčuje, kde se osoba nachází. Bez kontextu země toto pole vynechte.
Příklad spusťte na svém serveru s nastaveným GENDERAPI_API_KEY. Díky POST zůstane e-mailová adresa mimo URL požadavku. Výsledek v reálném čase se může lišit od ilustrativní odpovědi v ukázce.
Vyberte programovací jazyk. Nastavte API klíč, potom spusťte příklad na svém serveru.
Každý požadavek na odhad je nová zpoplatněná operace, včetně opakování. Tyto příklady požadavky automaticky neopakují. Před odesláním dalšího požadavku zkontrolujte stav účtování.
Před spuštěním: přístup a zpracování chyb
Tyto příklady spouštějte na svém serveru. V prostředí procesu nastavte GENDERAPI_API_KEY na svůj stávající API klíč. Ověřte, že meta.access.mode je api_key: nerozpoznaný klíč může přejít na zkušební režim podle IP.
U odpovědí JSON s HTTP 4xx a 5xx příklady zachovají tělo chyby a skončí s nenulovým návratovým kódem. Před opakováním požadavku zkontrolujte code, action a meta.usage.billing_status.
Průvodce chybami a opakováním požadavků →cURL 7.76+ v shellu POSIX. Spusťte v terminálu. Dokumentace běhového prostředí
Node.js 22+; vestavěné fetch. Uložte jako example.mjs a spusťte node example.mjs. Dokumentace běhového prostředí
Python 3.10+; standardní knihovna. Uložte jako example.py a spusťte python3 example.py. Dokumentace běhového prostředí
PHP 8+ s rozšířením cURL. Uložte jako example.php a spusťte php example.php. Dokumentace běhového prostředí
Java 17+; standardní HTTP klient. Uložte jako GenderApiExample.java a spusťte java GenderApiExample.java. Dokumentace běhového prostředí
Konzolová aplikace .NET 8+. Použijte jako Program.cs v konzolovém projektu a potom spusťte dotnet run. Dokumentace běhového prostředí
Go 1.22+; standardní knihovna. Uložte jako main.go a spusťte go run main.go. Dokumentace běhového prostředí
Uchovávejte výsledek spolu s jeho podklady
Odvozené přiřazení není pohlaví, které osoba sama uvedla. Původní vstup, vrácené podklady a údaje, které poskytla sama osoba, uchovávejte odděleně. Neznámý výsledek je platný výsledek a ve vaší aplikaci by se z něj neměla stát odhadnutá kategorie.
| Pole | Jak ho použít |
|---|---|
data.gender / data.result_status | male nebo female používejte jen u výsledku identified. U neznámého výsledku zachovejte původní hodnotu JSON null. |
data.name / data.match | Zkontrolujte vrácené jméno a vybraného kandidáta. Shoda s částí řetězce nedokazuje, že vstup patří osobě s tímto křestním jménem. |
data.confidence / data.confidence_kind | Spolehlivost je hodnota od 0 do 1, nebo null. observed_frequency vychází z uložených četností; model_reported je skóre AI. Prahové hodnoty vyhodnocujte pro každý druh zvlášť. |
data.source / data.sample_count | Rozlišujte dataset, ai a none. Výsledky AI nemají uloženou velikost vzorku. Velikost vzorku není naměřená přesnost. |
meta.access.mode | V integraci s účtem ověřte, že je uvedeno api_key. Chybějící nebo nerozpoznané klíče mohou místo toho použít sdílený zkušební režim podle IP. |
meta.usage | Čtěte charged_credits a billing_status. Úspěšný neznámý výsledek se účtuje. Ztracená odpověď nedokazuje, že požadavek byl zdarma. |
Rozhodněte, kdy použít AI
forceToGenderize je volitelné pro jména, e-mailové adresy i uživatelská jména. Pokud je zapnuté, ai_mode vynechte nebo použijte fallback; off a always jsou s ním v konfliktu a vrátí 422. K zahájení požadavku stačí kladný počáteční zůstatek, i když konečné vyúčtování dostane zůstatek do záporu.
Režim přezdívek může vrátit pohlaví spolu s name: null. Může také vrátit neznámý výsledek. Běžná záložní AI ani analýza přezdívek nezaručuje správnou odpověď ani hodnotu jinou než null.
| Možnost požadavku | Chování | Kredity za úspěšné vyhledání |
|---|---|---|
| options.ai_mode: off | Použije pouze datovou sadu. | 1, včetně neznámého výsledku |
| options.ai_mode: fallback | Nejprve prohledá datovou sadu, a pokud nevrátí pohlaví, použije běžnou AI. Jde o výchozí nastavení jednotlivých požadavků. | Celkem 1, včetně záložní AI |
| options.ai_mode: always | Použije přímo AI. | 2 |
| forceToGenderize: true | Nejprve prohledá datovou sadu a potom umožní AI vyložit osobní přezdívku nebo alias, i bez skutečného křestního jména. | 1 za výsledek z datové sady; celkem 2, pokud se použije AI |
Zpracujte seznam e-mailových adres v dávkách
Použijte POST /api/v2/gender/batch s polem items obsahujícím položky s type: email. Přístup s registrovaným API klíčem podporuje až 50 položek, zkušební režim podle IP až 10. Každé položce ponechte jedinečné id, abyste mohli výsledky přiřadit zpět k původnímu řádku. Odpověď navíc zachovává pořadí vstupů a uvádí index.
Položky dávky mají ve výchozím nastavení režim pouze s datovou sadou. U každé položky, která potřebuje běžnou záložní AI, nastavte options.ai_mode: fallback. Dvě úspěšné položky s fallback stojí celkem 2 kredity, a to i při neznámých výsledcích; jeden požadavek HTTP neznamená jeden kredit za odhad.
Kontrolujte každou položku, i když dávka vrátí HTTP 200. Uložte úspěšné i neznámé výsledky a teprve po kontrole chyb a potvrzeného účtování znovu odešlete neúspěšné položky. Po vypršení časového limitu neposílejte celou úspěšnou dávku znovu, aniž byste zkontrolovali výsledek účtování.
Vězte, co odesíláte
Ukázka v reálném čase odešle zadanou hodnotu do GenderAPI.io jen tehdy, když ji sami odešlete. Pokud se použije AI, předá se odeslaný type, value a kontext země službě nakonfigurované pro odhady. Pro odhad pouze z datové sady nastavte ve své integraci options.ai_mode: off bez forceToGenderize.
Zásady ochrany osobních údajů, smlouva o zpracování osobních údajů a seznam dalších zpracovatelů popisují zveřejněné podmínky zpracování. Výsledek je odvozené přiřazení; přednost mají údaje, které poskytla sama osoba. Nepoužívejte ho jako podklad pro rozhodnutí se závažnými důsledky pro jednotlivce.
Časté dotazy
Dokáže API získat z e-mailové adresy křestní jméno?
Pokud lokální část obsahuje použitelný signál, může vrátit kandidáta na jméno. Možná je shoda celých částí i podřetězců, proto zkontrolujte data.match. Výsledek nedokazuje křestní jméno vlastníka schránky.
Vrátí adresa jako info@ nebo support@ pohlaví?
Sdílené rolové adresy obvykle neposkytují žádné podklady pro osobní jméno. Neznámý výsledek je platný. AI ani režim přezdívek nepovažujte za ověření osob, které sdílenou schránku používají.
Stojí neznámý výsledek pro e-mailovou adresu kredity?
Ano. Úspěšné běžné vyhledání e-mailové adresy stojí 1 kredit, včetně záložní AI a neznámých výsledků. Vynucená analýza přezdívek stojí 1 kredit za výsledek z datové sady, nebo celkem 2 kredity, pokud se použije AI. U chyb je výsledek účtování uveden zvlášť v meta.usage.
Odstraní se e-mailová doména před zpracováním pomocí AI?
Takové odstranění se neslibuje. Kandidáti z datové sady pocházejí z lokální části, zatímco AI obdrží odeslanou hodnotu s pokynem ignorovat doménu a příponu za znakem plus. Pokud to váš postup vyžaduje, použijte režim pouze s datovou sadou.