Документация API v2.4

SnapStack API Reference

High-performance screenshots for modern apps

Полная спецификация REST API для интеграции службы захвата экранов в ваши приложения. Поддержка WebSockets, асинхронных задач и пакетных запросов.

Base URL: https://api.snapstack.io/v2

Endpoints

Основные маршруты для инициализации захвата, проверки статуса и получения результатов.

POST /capture

Инициализирует новый процесс рендеринга страницы. Принимает URL и параметры конфигурации в теле запроса.

Status: 202 Accepted

Возвращает taskId для отслеживания прогресса через WebSocket или опрос.

GET /tasks/{id}

Получение статуса задачи захвата. Возвращает JSON с полями status (pending, processing, completed, failed) и progress.

Status: 200 OK

Используется для polling-интеграций, если WebSocket недоступен.

GET /tasks/{id}/image

Прямая ссылка на результат. Доступна только после завершения задачи.

Status: 200 OK

Content-Type: image/png или image/jpeg (в зависимости от запроса).

POST /batch

Пакетный запрос для генерации скриншотов нескольких URL одновременно. Максимум 50 URL на запрос.

Status: 202 Accepted

Возвращает массив taskIds.

Parameters

Детальное описание допустимых параметров запроса для точной настройки рендеринга.

url (string)

Обязательный. Полный URL страницы для захвата. Поддерживаются http/https.

Пример: https://example.com/products/123

viewport_width (integer)

Ширина окна браузера в пикселях.

По умолчанию: 1920
Диапазон: 320–3840

viewport_height (integer)

Высота окна браузера в пикселях.

По умолчанию: 1080
Диапазон: 240–2160

format (enum)

Формат выходного изображения.

Значения: png (по умолчанию), jpeg, webp

quality (integer)

Качество сжатия для форматов jpeg и webp.

По умолчанию: 80
Диапазон: 1–100

wait_until (enum)

Условие завершения загрузки страницы перед захватом.

Значения: load, networkidle (рекомендуется), domcontentloaded

full_page (boolean)

Если true, захватывается вся прокручиваемая страница, а не только видимая область.

По умолчанию: false

block_ads (boolean)

Включает встроенный блокировщик рекламы и трекеров перед рендерингом.

По умолчанию: false