Переглянути документацію
Довідник API
Знайдіть причину невдалого запиту і вирішіть, чи зафіксуйте її, чекайте чи птиця.
На цій сторінці
Коди статусу HTTP
Почати з статусом HTTP, потім читати код помилки і повідомлення для конкретної причини.
| Статус на сервери | Зручності | Що робити |
|---|---|---|
| 400 | Запит на валідацію | Виправлення джерела, необхідних полів, типів параметрів або відповідей заголовків до переробки. |
| 401 | Ауттентифікація не вдалося | Перевірте X-API-Key. Замініть відірваний або відкликаний ключ; переробляючи той самий ключ не допоможе. |
| 402 | Недостатні кредити | Перевірити залишок рахунку. Введіть номер мобільного, який Ви вказали при укладаннi договору з банком - для ідентифікації. |
| 403 | Відхилено доступ | Перевірити основні дозволи та обліковий запис або статус підписки. |
| 404 | Не знайдено | Перевірити URL, роботу ID і обліковий запис. Також можна повернути 404. |
| 406 | Тип відповіді не прийнятний | Використання Accept: application/json або text/plain. Виберіть Markdown з X-Respond-With: розмітка. |
| 409 | Результат не готовий / конфлікт | На результат читайте, обпиляти існуючу роботу до завершення. Для інших кінцевих точок розв’язати конфлікт, описаний в організмі. |
| 410 | Результат розірвав | Використовуйте збережену копію. Зняття результату URL не може відновити результат. |
| 422 | Вступ / невдала робота | Виправлення повідомлень полів. На результаті читайте, перевірте job.error: невдала робота не має вдалого результату fetch. |
| 429 | Досягнення | Зачекайте Retry-After або retry_after. Знижувати швидкість запиту; за повну черги, почекайте існуючі роботи до finish. |
| 500 / 502 / 503 / 504 | Сервіс або відмова в перебігу | Ретри читає з обмеженим відключенням. За час відправлення 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 з ноткою | Заслужений 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, якщо вказавши charset. |
Отримати допомогу за запитом
Відправте кінцеву точку, UTC timestamp, HTTP статус, код помилки та запит або роботу ID. Видалити API ключі, токени і підписаний URLs з звіту.