Przejdź do treści
PL
Uzyskaj klucz API
Przeglądaj dokumentację

Dokumentacja API

Błędy i kody statusu

Znajdź przyczynę nieudanego żądania i zdecyduj, czy go naprawić, poczekać lub spróbować ponownie.

Na tej stronie

Kod statusu HTTP

Zacznij od statusu HTTP, a następnie przeczytaj kod błędu i wiadomość dla konkretnej przyczyny.

StanZnaczenieCo zrobić
400Nieprawidłowy wniosekPrzed ponownym uruchomieniem poprawiaj źródło, wymagane pola, typy parametrów lub nagłówki odpowiedzi.
401Uwierzytelnianie nie powiodło sięSprawdź X-API-Key. Zastąp utracony lub cofnięty klucz; ponowne użycie tego samego klucza nie pomoże.
402Niewystarczające kredytySprawdź stan konta. Dodaj kredyty lub pozwól właścicielowi konta rozwiązać dostęp przed przedłożeniem ponownie.
403Odmowa dostępuSprawdź prawa źródłowe klucza oraz status konta lub subskrypcji.
404Nie znalezionoSprawdź URL, zadanie ID i konto. Praca poza dozwolonym kontem lub źródłami może również zwrócić 404.
406Typ odpowiedzi nie do przyjęciaUżyj Accept: application/json lub text/plain. Wybierz Markdown z X-Respond-With: markdown.
409Wynik niegotowy / konfliktNa wynik przeczytaj, przeprowadź badanie istniejącej pracy aż do zakończenia. Dla innych punktów końcowych, rozwiązać konflikt opisany w organizmie.
410Wynik wygasłUżyj zapisanej kopii. Pobieranie wyniku URL nie może przywrócić przeterminowanego wyniku.
422Nieprawidłowe zadanie wejścia / nieudanego zadaniaNapraw zgłoszone pola. Na wynik przeczytany, Inspect job.error: nieudany zadanie nie ma udanego wyniku do pobrania.
429Osiągnięty limitPoczekać na Retry-After lub retry_after. Zredukuj stawkę żądania; dla pełnej oczekujących kolejki, czekać na istniejące zadania do finish.
500 / 502 / 503 / 504Usterka serwisowa lub awaryjnaRetry czyta z ograniczonym zapleczem. Dla POST lub timeout składania, sprawdzić, czy praca została zaakceptowana przed wysłaniem go ponownie.

Odczytaj odpowiedź błędu

Błędy API używają JSON, w tym również w przypadku żądania zwykłego tekstu. Ciało różni się w zależności od punktu końcowego. Oddział na statusie i kodzie HTTP, gdy jest obecny; użyj wiadomości lub szczegółów, aby wyjaśnić problem.

Błędy w zapytaniu często zawierają błąd i wiadomość; kod jest opcjonalny. Błędy uwierzytelniania mogą stosować success: false zamiast error: true.

400 · application/json
{
  "error": true,
  "code": "unsupported_representation",
  "message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}

Stan kontroli, nagłówki i ciało

Używać curl --include, aby zobaczyć wszystkie trzy. Ten przykład sprawdza Twój klucz za pomocą darmowego odczytu konta; nie wysyła zapytania. Najpierw ustaw FLASHDATA_API_KEY w swoim środowisku.

Sprawdzić odpowiedź · cURL / Bash
curl --include --silent --show-error --max-time 20 \
  'https://api.flashdata.dev/v2/api-access/identity' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Kiedy spróbować ponownie

Powtórzone POST może utworzyć kolejne billable query. Czas trwania sieci nie dowodzi, że pierwszy wniosek został odrzucony. Zapisz pracę ID jak tylko ją otrzymasz.

SytuacjaNastępna akcja
Nieprawidłowe wejście, klucz, pozwolenie lub równowagaPrzestań. Przed ponownym uruchomieniem należy naprawić żądanie lub stan konta; nie pętli tych błędów.
429 z podpowiedź oczekiwaniaHonor Retry-After (sekundy lub data HTTP) lub wartość JSON retry_after w sekundach. Jeśli obie są obecne, należy użyć dłuższego opóźnienia.
Read request: 429 / internal 5xx / network errorZmień GET. Bez podpowiedzi, użyj zwiększających się opóźnień z jitter, maksymalnej liczby prób i limitu czasu.
POST timeout lub digital 5xxZachowaj dotychczasową pracę ID i sprawdź jej status. Jeśli nie otrzymano ID, przed podjęciem decyzji o ponownym złożeniu sprawdź historię pracy.

Sprawdź pracę w tle

HTTP 200 od punktu końcowego stanu oznacza, że odczyt się powiódł. Sprawdź job.status, aby wiedzieć, czy zadanie się powiodło. Ustaw JOB_ID do istniejącego zadania; to polecenie nie wysyła zastępstwa.

job.statusCo zrobić
pending / processingCzekaj, przeprowadź sondaż tej samej pracy. Wynik odczytu zwraca 409 do zakończenia.
completedOdzyskać i zapisać wynik. Oryginalne wyniki JSON zwracają 302 przekierowanie pamięci; sformatowane wyniki zwracają ciało bezpośrednio.
failedZatrzymaj sondaże i sprawdź job.error. Wynik końcowy zwraca 422 kodem result_not_ready dla nieudanego zadania.
Odczytuj status zadania · cURL / Bash
curl --fail-with-body --silent --show-error --max-time 30 \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Błędy w formacie odpowiedzi

Stan / kodNapraw
400 · unsupported_representationUstaw X-Respond-With na markdown lub usuń nagłówek.
406 · not_acceptableUstaw Accept na application/json lub text/plain; użyj UTF-8, jeśli zostanie określony zestaw znaków.

Skontaktuj się z pomocą z prośbą

Wyślij punkt końcowy, znacznik czasu UTC, status HTTP, kod błędu i żądanie lub zadanie ID. Usuń z raportu klucze API, żetony i podpisane URLs.