Обзор документации
Справочник 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.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}В ответах на проблемы V2 используется application/problem+json. Поддерживайте requestId. Ошибки проверки могут также включать fieldErrors с полем, кодом и сообщением.
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}Проверить статус, заголовки и тело
Используйте curl --include, чтобы увидеть все три. Этот пример проверяет ваш ключ с помощью бесплатного чтения учетной записи; он не отправляет запрос. Сначала установите FLASHDATA_API_KEY в вашей среде.
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 --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 из отчета.