Dokumentacja błędów

Obsługuj błędy API w przewidywalny sposób

Rozpoznaj nieudane zapytanie GenderAPI po stabilnej wartości errno, a następnie zastosuj właściwe działanie naprawcze.

Sprawdź najpierwstatus: falseerrnoerrmsg

Struktura odpowiedzi

Odczytaj obiekt błędu

Gdy zapytanie się nie powiedzie, odpowiedź JSON zawiera status równy false. W logice aplikacji używaj liczbowego errno, a errmsg zachowaj do logów i czytelnej diagnostyki.

JSON · przykładowy błąd
{
  "status": false,
  "errno": 94,
  "errmsg": "invalid or missing key"
}
Reguła implementacji: Steruj logiką na podstawie errno, a nie dokładnego brzmienia errmsg. Dzięki temu integracja pozostanie stabilna, nawet jeśli tekst objaśnienia później się zmieni.

Pełna lista

Kody błędów GenderAPI

Poniższe wartości odpowiadają bieżącej publicznej dokumentacji GenderAPI. Usuń przyczynę przed ponowieniem zapytania.

errno50
access denied

Zapytanie pochodzi z nieautoryzowanego adresu IP lub odsyłacza.

Sprawdź ograniczenia dostępu przypisane do klucza API.
errno90
invalid country code

Wartość kraju nie jest obsługiwanym kodem ISO 3166-1 alpha-2.

Zweryfikuj i ujednolić kod kraju przed ponowną próbą.
errno91
name not set || email not set || username not set

W zapytaniu brakuje wymaganego parametru name, email lub username.

Dodaj wymagane dane wejściowe dla wywoływanego endpointu.
errno92
too many names || too many emails || too many usernames

Zapytanie przekracza limit partii: 100 imion, 50 adresów e-mail lub 50 nazw użytkowników.

Podziel dane na mniejsze partie i wyślij je osobno.
errno93
query limit reached

Dla klucza API nie pozostały żadne kredyty.

Wstrzymaj zadania i uzupełnij saldo konta.
errno94
invalid or missing key

Brakuje klucza API albo nie można go odnaleźć.

Sprawdź sposób przekazywania danych uwierzytelniających i użyj prawidłowego klucza po stronie serwera.
errno99
API key has expired

Pakiet powiązany z kluczem API wygasł.

Odnów pakiet przed wysłaniem kolejnego zapytania.

Zasady obsługi

Reaguj bezpiecznie i unikaj ślepych ponowień

01

Waliduj przed wysłaniem

Odrzucaj brakujące dane, błędne kody krajów i zbyt duże partie, zanim trafią do API.

02

Chroń dane uwierzytelniające

Przechowuj klucze API na serwerze i usuwaj je z logów, odpowiedzi przeglądarki oraz zrzutów ekranu.

03

Ponawiaj wybiórczo

Te błędy wymagają poprawienia zapytania lub działania na koncie. Powtarzanie niezmienionego żądania ich nie usunie.

TypeScript · kontrola odpowiedzi
type GenderApiError = {
  status: false;
  errno: number;
  errmsg: string;
};

if (response.status === false) {
  handleGenderApiError(response.errno, response.errmsg);
}

Nie ujawniaj szczegółów diagnostycznych

Zapisuj numer błędu razem z wewnętrznym identyfikatorem zapytania, ale nigdy z kluczem API. Użytkownikowi pokaż krótką instrukcję działania zamiast surowych danych uwierzytelniających lub informacji wewnętrznych.

Dokumentacja ukończona

Kontynuuj pracę z GenderAPI

Wykorzystanie i limitMonitoruj dostępne kredyty →CennikPorównaj pakiety kredytów →