Документация

Поля сайта и параметры запросов

Объявленные ссылки site_id, script_id, version_id, agent_id и другие идентификаторы ресурсов принимают число, UUID или короткую форму. Числовые примеры ниже относятся к v1 без выбора UUID. Курсоры и ключи записей не меняют формат. Подробнее.

Настройки сайта

Создание: POST /api/v1/sites; изменение: PATCH /api/v1/sites/{id}. PATCH меняет только переданные поля.

Поле	Значение
`name`, `base_url`	Название до 255 символов и полный адрес сайта
`code`	При создании обязателен, уникален в пространстве; после создания неизменяем
`is_active`	Включён ли источник
`render_mode`	`http` или `browser`
`respect_robots`	Учитывать robots.txt, логическое значение
`rps`, `burst`	Частота 1–50 запросов/с и размер всплеска 1–100
`concurrency`	Параллельные запросы 1–20; ограничение частоты сохраняется
`min_delay_ms`, `jitter_ms`	Минимальная и случайная задержка, 0–60 000 мс
`timeout_ms`	Тайм-аут запроса, 1 000–180 000 мс
`retry_attempts`	Попыток HTTP-запроса, 1–10
`cache_ttl_seconds`	Время кэша, 0–2 592 000 секунд
`browser_wait_selector`	Селектор элемента, появления которого нужно дождаться
`browser_wait_ms`	Дополнительное ожидание, 0–60 000 мс
`escalate_to_browser`	Разрешить переход от HTTP к браузеру
`max_run_seconds`	Ограничение прогона, 10–172 800 секунд, либо null
`execution_target`, `agent_id`	`internal` или `agent`; для агента нужен доступный идентификатор
`proxy_pool_id`	Пул текущего пространства или null
`params`	Объект параметров сценария

Числовые технические диапазоны не расширяют тариф: платформа дополнительно проверяет доступные ресурсы.

Полная схема полей

Сначала прочитайте GET /sites/{id}/fields. Ответ содержит items, а также справочники types и transforms с актуальными допустимыми значениями.

PUT /sites/{id}/fields заменяет весь список. Поля, которых нет в запросе, удаляются из схемы. Не отправляйте только одну изменённую строку, если нужно сохранить остальные.

{
  "items": [
    {"code":"sku","name":"Артикул","type":"string_numeric","is_key":true,"is_required":true},
    {"code":"name","name":"Название","type":"string","is_required":true},
    {"code":"price","name":"Цена","type":"decimal"}
  ]
}

До 200 полей. Код начинается с латинской буквы и содержит только строчные латинские буквы, цифры и _. is_key участвует в распознавании записи; is_required требует значение. Для артикула с ведущими нулями используйте строковый тип, не integer.

Доступны string, string_numeric, integer, decimal, boolean, date, datetime, url, enum, json, collection. Дополнительные поля: rules, transforms, default_value, description. Не все типы могут быть ключом: сервер проверит схему.

Проверка преобразования одного значения: POST /sites/{id}/fields/preview с {"value":" Товар ","transforms":["trim"]}. Список допустимых преобразований берите из справочника, а не угадывайте.

Чтение записей и журнала

GET /sites/{id}/records принимает search, since, include_deleted, cursor, limit. Продолжение приходит в next_cursor. Поиск работает по ключу записи. История конкретной записи: /records/{key}?history=20.

Журнал прогона: /runs/{id}/log?after=123&limit=100; after: числовой cursor из предыдущего ответа. В UUID-режиме ID строки становится UUID, но курсор остаётся числовым. Можно фильтровать по level. Журнал HTTP: /runs/{id}/http-log?after=123. Для скачивания снимка через ключ используйте путь /api/v1/sites/{site}/artifacts/{uuid}; ссылки интерфейса могут содержать неверсионированный префикс.

Фотографии товаров

В схеме записей доступны типы image для основного фото и gallery для списка до 50 фотографий. Сценарий передаёт URL или список URL; после боевого сбора фотографии сохраняются в выбранное хранилище, а запись содержит приватные ссылки с размерами и форматом. В пробном прогоне файлы не выгружаются.

Готовые сценарии Wildberries заполняют main_image и gallery. В таблице их можно показывать отдельными столбцами, а в карточке открывать через галерею с увеличением. Хранилище меняется в настройках сайта: по умолчанию используется Akmelo, можно выбрать S3 своего пространства. Личный сценарий не получает доступ к хранилищу другой команды. На своём агенте фотографии по умолчанию остаются локально.

CAPTCHA

Настройка CAPTCHA и API: автоматический режим, отключение, параметры сайта, агент и проверка результата. Пользовательское руководство и цены.

Явные задания ctx.captcha() используют те же количество в тарифе, пределы стоимости и баланс пространства. Просмотр каталога и оценка цены не создают задание. В актуальном прайсе есть типы для явного API наряду с браузерными; наличие типа в каталоге не включает его автоматическую обработку браузером. Явный API.