Podstawowe użycie
Wykonaj pierwsze zapytanie do Gender API
Wyślij jedną wartość i odbierz przewidywaną płeć, prawdopodobieństwo, kraj oraz informacje o wykorzystaniu kredytów. Zacznij od imienia, a dla adresu e-mail lub nazwy użytkownika wybierz dedykowany endpoint.
Dodaj klucz API w parametrze key. Klucze produkcyjne przechowuj po stronie serwera — nigdy nie ujawniaj prywatnego klucza w kodzie przeglądarki ani publicznym repozytorium.
Użyj aktualnego kontraktu GenderAPI w formacie OpenAPI, Swagger lub Postman.
Płeć na podstawie imienia
Imię lub imię i nazwisko
Użyj głównego endpointu, gdy wejściem jest imię albo pełne imię i nazwisko.
https://api.genderapi.io/apicurl "https://api.genderapi.io/api?name=Anna&country=PL&key=YOUR_API_KEY"Parametry opcjonalne
| Parametr | Typ | Opis |
|---|---|---|
country | string | Dwuliterowy kod kraju, na przykład PL lub US. |
askToAI | boolean | Wartość true uruchamia wsparcie AI, gdy imienia nie ma w bazie danych. |
forceToGenderize | boolean | Próbuje określić płeć dla nietypowych wartości, które mogą nie przypominać imion osób. |
Płeć na podstawie e-maila
Adres e-mail
Endpoint e-mail najpierw wyodrębnia prawdopodobne imię z adresu, a następnie określa płeć.
https://api.genderapi.io/api/emailcurl "https://api.genderapi.io/api/email?email=anna.kowalska%40example.com&country=PL&askToAI=true&key=YOUR_API_KEY"forceToGenderize nie jest dostępne dla tego endpointu, ponieważ imię jest wyodrębniane wewnętrznie.Płeć na podstawie nazwy użytkownika
Nazwa użytkownika lub pseudonim
Użyj tego endpointu dla nazw użytkowników, nicków i pseudonimów, które mogą zawierać rozpoznawalne imię.
https://api.genderapi.io/api/usernamecurl "https://api.genderapi.io/api/username?username=anna_kowalska&country=PL&askToAI=true&forceToGenderize=true&key=YOUR_API_KEY"Odpowiedź JSON
Jak interpretować odpowiedź GenderAPI
Wszystkie trzy endpointy korzystają z tej samej podstawowej struktury odpowiedzi.
{
"status": true,
"used_credits": 1,
"remaining_credits": 4999,
"expires": 1743659200,
"q": "Anna",
"name": "anna",
"gender": "female",
"country": "PL",
"total_names": 325,
"probability": 98,
"duration": "4ms"
}Pola odpowiedzi
| Pole | Typ | Opis |
|---|---|---|
status | boolean | Informuje, czy zapytanie zakończyło się powodzeniem. |
used_credits | integer | Liczba kredytów wykorzystanych przez to zapytanie. |
remaining_credits | integer | Liczba kredytów pozostałych po wykonaniu zapytania. |
expires | integer | Czas wygaśnięcia pakietu jako znacznik UNIX. |
q | string | Oryginalne imię, adres e-mail lub nazwa użytkownika. |
name | string | Znormalizowane lub wyodrębnione imię. |
gender | string | Przewidywana płeć: male, female albo "null". |
country | string | Najbardziej prawdopodobny dwuliterowy kod kraju ISO 3166-1 alpha-2. |
total_names | integer | Liczba rekordów imion wykorzystanych do prognozy. |
probability | integer | Poziom pewności prognozy wyrażony w procentach. |
duration | string | Czas przetwarzania zapytania po stronie serwera. |
Zawsze koduj wartości w adresie URL
Klient HTTP musi zakodować spacje i znaki specjalne. Użyj na przykład anna%20kowalska zamiast niezakodowanej spacji.
Kontynuuj integrację