Перейти к содержимому
RU
Ключ API
Обзор документации

Справочник API

Ошибки и коды состояния

Найдите причину неудачного запроса и решите, исправить ли его, подождать или повторить.

На этой странице

Коды состояния HTTP

Начните со статуса HTTP, затем прочитайте код ошибки и сообщение для конкретной причины.

СтатусЗначениеЧто делать
400Недействительный запросИсправьте источник, требуемые поля, типы параметров или заголовки ответов перед повторным использованием.
401Аутентификация провалиласьПроверьте X-API-Key. Заменить просроченный или отозванный ключ; повторная подача одного и того же ключа не поможет.
402Недостаточные кредитыПроверьте баланс счета. Добавьте кредиты или позвольте владельцу учетной записи разрешить доступ, прежде чем отправлять снова.
403Доступ запрещенПроверьте исходные разрешения ключа и статус учетной записи или подписки.
404Не найденоПроверьте URL, работу ID и аккаунт. Работа за пределами вашей разрешенной учетной записи или источников также может вернуть 404.
406Тип ответа не приемлемAccept: application/json или text/plain. Выберите Markdown с помощью X-Respond-With: разметка.
409Результат не готов / конфликтВ результате читайте, опрашивайте существующую работу, пока она не завершится. Для других конечных точек необходимо разрешить конфликт, описанный в организме.
410Результат истекИспользуйте сохраненную копию. Восстановление результата URL не может восстановить просроченный результат.
422Недействительный вход / неудавшаяся работаИсправьте отчитавшиеся поля. Оцените job.error: неудачная работа не имеет успешного результата.
429предела достигнутогоПодождите Retry-After или retry_after. Уменьшите ставку запроса; для полной очереди ожидайте существующих рабочих мест до finish.
500 / 502 / 503 / 504Служебный или восходящий отказRetry читается с ограниченным обратным ходом. Для POST или тайм-аута отправки проверьте, была ли принята работа, прежде чем отправлять ее снова.

Прочитайте ответ на ошибку

Ошибки API используют JSON, в том числе при запросе простого текста. Тело отличается по конечной точке. Отделение по статусу и коду HTTP при наличии; используйте сообщение или деталь для объяснения проблемы.

Ошибки запроса обычно включают ошибку и сообщение; код необязателен. Ошибки аутентификации могут использовать success: false вместо error: true.

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

Проверить статус, заголовки и тело

Используйте curl --include, чтобы увидеть все три. Этот пример проверяет ваш ключ с помощью бесплатного чтения учетной записи; он не отправляет запрос. Сначала установите FLASHDATA_API_KEY в вашей среде.

Проверить ответ · 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'

Когда повторно

Повторяющийся POST может создать еще один платежный запрос. Сетевой тайм-аут не доказывает, что первый запрос был отклонен. Сохраните работу ID, как только получите ее.

ПоложениеСледующее действие
Недействительный вход, ключ, разрешение или балансСтой. Исправьте состояние запроса или учетной записи перед повторным использованием; не зацикливайтесь на этих ошибках.
429 с подсказкой ожиданияHonor Retry-After (вторы или дата HTTP) или значение JSON retry_after в секундах. Если оба присутствуют, используйте более длительную задержку.
Запрос на чтение: 429 / временная ошибка 5xx / сетевая ошибкаПовторите тот же GET. Без подсказки ожидания используйте увеличивающиеся задержки с дрожанием, максимальный подсчет попыток и ограничение по времени.
POST тайм-аут или двусмысленный 5xxДержите существующую работу ID и проверьте ее статус. Если ID не был получен, проверьте историю работы, прежде чем снова подать заявку.

Проверьте фоновую работу

HTTP 200 от конечной точки состояния означает успешное чтение. Проверьте job.status, чтобы узнать, удалась ли задача. Установите JOB_ID на существующую работу; эта команда не подает замену.

job.statusЧто делать
pending / processingПодожди, тогда проверь ту же работу. Результат считывания возвращает 409 до завершения.
completedВосстановить и сохранить результат. Оригинальные результаты JSON возвращают перенаправление хранилища 302; отформатированные результаты возвращают тело напрямую.
failedОстановите опрос и проверьте job.error. Конечная точка результата возвращает 422 с кодом result_not_ready для неудачной работы.
Статус работы · 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'

Ошибки формата ответа

Статус/кодисправлять
400 · unsupported_representationУстановите X-Respond-With для разметки или удалите заголовок.
406 · not_acceptableУстановите Accept на application/json или text/plain; используйте UTF-8, если указываете набор.

Получить помощь с просьбой

Отправьте конечную точку, временную метку UTC, статус HTTP, код ошибки и запрос или задание ID. Удалите ключи API, токены и подписанные URLs из отчета.