К содержимому
Akmelo

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

Получение результатов

Записи сайта

GET /api/v1/sites/{site}/records возвращает сохранённые записи. Это результат обработки, а не HTML страницы. Для одной записи используйте /records/{key}; ключ кодируйте как часть URL.

Состояние и журналы прогона доступны через /api/v1/runs/{run}. Если сбор выполнялся на агенте, читать синхронизированные результаты можно через эти же методы центральной системы.

Управление выгрузкой

  1. Получите модули: GET /api/v1/exports/modules. Модули «в разработке» нельзя считать доступными.
  2. Создайте выгрузку: POST /api/v1/exports, задав site_id, name, format и схему schema. Код можно не указывать: система создаст его.
  3. Получите предложение полей через /exports/{id}/suggest-schema; настройте схему через PATCH.
  4. Проверьте /exports/{id}/preview.
  5. Подготовьте файл: POST /exports/{id}/run.
  6. История: GET /exports/{id}/runs. В files находятся подготовленные файлы.

Скачивание с API-ключом: GET /api/v1/exports/files/{uuid}. Для ссылок интерфейса вида /api/exports/files/{uuid} используйте версионированный путь при серверной интеграции. Проверяйте состояние подготовки и наличие файла: создание настройки выгрузки не создаёт файл автоматически.

Пример схемы и преобразования проще сначала настроить в интерфейсе и прочитать через GET /exports/{id}: структура зависит от формата. Настройка полей, обработка кодом.

Прямой endpoint каталога

Для получателя, которому нужен только результат, выдайте отдельный токен выгрузки с ограничением сайта, выгрузки и формата. Путь: /api/export/{site_code}/{export_code}.{format}. Форматы: JSON, XML, CSV. Этот endpoint не использует API-ключ управления.

Подробный контракт пагинации, курсоров и JSON-обёртки: выгрузка по ссылке. Не путайте пагинацию выдачи готовых данных с обходом страниц сайта: обход реализуется в сценарии.

Доставки и подключения

Подключения создаются через /connections, доставки: через /exports/{id}/deliveries. Для ручной доставки вызовите POST /deliveries/{id}/run: 202 означает очередь. При сбросе курсора доставка может повторно отправить уже переданные записи. Согласуйте обработку дублей с получателем.

Внешнее хранилище или БД не расходует наше место для размещённых там данных. Время передачи и обработки учитывается. API-запрос не отключает эти правила.

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

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

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