Статьи

Получить скриншот вебхуком

Вызов создания возвращается, как только задание поставлено в очередь. callback_url — адрес, куда доставляется готовая съёмка. URL файла в этом теле подписан, и у него есть срок. Скачайте файл, когда придёт вебхук, или запросите скриншот снова позже.

Статьи по API скриншотов

Что отправляется

Когда статус равен ready, Site2image отправляет JSON методом POST на callback_url с Content-Type application/json. Тело включает id, status, url, format и image_url. Метаданные включаются, если вы их запросили. Фрагменты включаются, если они были сохранены. Ответ 2xx завершает доставку. Сбои сети и HTTP 5xx повторяются. Неудачная доставка оставляет скриншот в статусе ready, поэтому его всё ещё можно опросить.

Подпись тела

Задайте webhook_sign равным true. Тогда запрос включает заголовок X-Site2image-Signature со значением sha256= и шестнадцатеричным HMAC-SHA256 сырого тела. Ключ — ваш токен доступа. Вычислите тот же HMAC по полученным сырым байтам и сравните. Токен — это токен API, а не отдельный секрет вебхука. Проверять подпись может тот, у кого есть этот токен.

Какие адреса принимаются

callback_url следует тому же правилу, что и адрес страницы. Это публичный http или https, не длиннее 2 048 символов. Localhost и частные адреса отклоняются до сохранения задания. В пакетном запросе задайте callback_url у каждого элемента, который должен вас уведомить. Каждый готовый элемент доставляется отдельно. У подписанного URL изображения короткий срок жизни. По умолчанию пять минут, поэтому сохраните файл, когда придёт вебхук.

Поля

Имена, которые принимает этот запрос
callback_url Публичный адрес http или https, который принимает готовый скриншот.
webhook_sign Отправляет X-Site2image-Signature: HMAC-SHA256 сырого тела с ключом из вашего токена доступа.
external_identifier Ваш собственный идентификатор. Сохраняется вместе с запросом, до 128 символов.

Вопросы

Сбой вебхука завершает скриншот ошибкой?

Нет. Скриншот остаётся ready. Повторная доставка делается для сетевых ошибок и HTTP 5xx. Скриншот по-прежнему можно запросить методом GET и скачать файл.

Как проверить подпись?

Прочитайте сырое тело, вычислите HMAC-SHA256 с вашим токеном доступа и сравните его с шестнадцатеричным значением после sha256= в X-Site2image-Signature.

Может ли у каждой строки пакета быть свой вебхук?

Да. callback_url задаётся для каждого элемента. Элементы доставляются по одному, когда соответствующая съёмка становится готовой.

Другие статьи

Альтернативы, которые используют эти поля

Сравнения

Отправьте первый адрес

Создайте аккаунт, скопируйте bearer-токен и отправьте POST с публичным адресом, HTML или Markdown.