К содержанию

Скриншоты

Статусы задач

Продолжайте опрос статуса (polling) для PENDING и IN_PROGRESS. DONE и ERROR завершают задачу.

Модель статусов

PENDING

Задача сохранена и ждёт обработки. Сохраните taskId и проверьте статус позже; создавать новую задачу из-за ожидания не нужно.

IN_PROGRESS

Воркер начал создавать скриншот. Продолжайте опрос статуса, делая паузу между запросами.

DONE

Задача успешно завершена. Скачайте результат из resultUrl, если ссылка доступна, и остановите опрос. payloadSize содержит размер, если он известен.

ERROR

Задача завершилась ошибкой. resultUrl равен null, а errorMessage может содержать описание ошибки. Остановите опрос; новый запрос создаст новую задачу и снова расходует квоту.

Переходы

text
PENDING -> IN_PROGRESS
PENDING -> DONE
PENDING -> ERROR
IN_PROGRESS -> DONE
IN_PROGRESS -> ERROR

Когда повторять запрос

Сохраните taskId и запрашивайте GET /v1/screenshots/{taskId}, пока задача не перейдёт в DONE или ERROR. Делайте паузу между запросами статуса — не отправляйте их в непрерывном цикле.

На PAID можно добавить timeoutSeconds от 1 до 60. Сервер ждёт, пока задача перейдёт в DONE или ERROR либо истечёт timeoutSeconds, и в любом случае возвращает JSON со статусом и HTTP 200.

Этот запрос отличается от POST /take: /take может вернуть бинарное изображение или JSON с HTTP 202. Обычный статусный запрос не возвращает изображение в теле ответа.

Поля ответа

ПолеЗначение
taskIdUUID задачи. Сохраните его до завершения обработки.
statusPENDING, IN_PROGRESS, DONE или ERROR.
resultUrlВременная ссылка на результат для DONE; иначе null.
errorMessageОписание ошибки, если оно доступно.
payloadSizeРазмер результата в байтах, если он известен.
waitUntilВыбранный режим навигации: load, domcontentloaded, networkidle или null для автоматического совместимого режима.
delayMsФактически использованная дополнительная задержка в миллисекундах.
waitForSelectorCSS-селектор ожидания или null, если ожидание элемента не задано.
selectorCSS-селектор снятого элемента или null для снимка страницы либо видимой области.
createdAtВремя создания задачи.
updatedAtВремя последнего обновления задачи.

Полный сценарий создания задачи описан в руководстве по асинхронному API. Вариант с изображением в том же запросе — в руководстве по синхронному API.