Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник 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.

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 з ноткоюЗаслужений 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, якщо вказавши charset.

Отримати допомогу за запитом

Відправте кінцеву точку, UTC timestamp, HTTP статус, код помилки та запит або роботу ID. Видалити API ключі, токени і підписаний URLs з звіту.