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.
{
"status": false,
"errno": 94,
"errmsg": "invalid or missing key"
}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.
access deniedZapytanie pochodzi z nieautoryzowanego adresu IP lub odsyłacza.
invalid country codeWartość kraju nie jest obsługiwanym kodem ISO 3166-1 alpha-2.
name not set || email not set || username not setW zapytaniu brakuje wymaganego parametru name, email lub username.
too many names || too many emails || too many usernamesZapytanie przekracza limit partii: 100 imion, 50 adresów e-mail lub 50 nazw użytkowników.
query limit reachedDla klucza API nie pozostały żadne kredyty.
invalid or missing keyBrakuje klucza API albo nie można go odnaleźć.
API key has expiredPakiet powiązany z kluczem API wygasł.
Zasady obsługi
Reaguj bezpiecznie i unikaj ślepych ponowień
Waliduj przed wysłaniem
Odrzucaj brakujące dane, błędne kody krajów i zbyt duże partie, zanim trafią do API.
Chroń dane uwierzytelniające
Przechowuj klucze API na serwerze i usuwaj je z logów, odpowiedzi przeglądarki oraz zrzutów ekranu.
Ponawiaj wybiórczo
Te błędy wymagają poprawienia zapytania lub działania na koncie. Powtarzanie niezmienionego żądania ich nie usunie.
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