Оформление
Управление компонентами сайта
Передавайте токен проекта в X-SN-TOKEN. Все пути ниже начинаются с /public/api/v1/manage/site-components. В {id} передавайте UUID компонента.
Получить каталог, список и компонент
| Запрос | Параметры | Результат, 200 OK |
|---|---|---|
GET /catalog?preset=cartGoal | Необязательный preset ограничивает набор шаблонов в ответе. | presets, sources, customSources. |
GET /?search=Cart | Необязательный поиск по названию без учёта регистра. | Массив кратких сведений с id, name, state, preset и признаками публикации. Пустой результат: []. |
GET /{id} | UUID в пути. | Компонент с draft, published, running, revision и usages. |
GET /library-assets?search=Logo | Необязательный поиск по библиотеке проекта. | Массив изображений с id, name, description, url и thumbnailUrl. Пустой результат: []. |
Возьмите defaults и fields выбранного preset из каталога. Используйте ID изображения из библиотеки проекта там, где шаблон поддерживает изображение.
Сохранить и проверить черновик
| Запрос | Тело и результат |
|---|---|
POST / | Передайте name и полную configuration, чтобы создать черновик. |
PUT /{id} | Передайте полный черновик. Добавьте последний полученный revision, чтобы API отклонил запись поверх более новых изменений. |
PATCH /{id} | Передайте изменения, например name, content или widthPx. Переданный variants заменяет весь список вариантов. conditions: null очищает условия показа компонента. |
Например, чтобы проверить компонент корзины перед сохранением, вызовите POST /?preview=true с этим JSON-телом. Остальные значения берутся из шаблона.
json
{
"name": "Demo cart goal",
"configuration": {
"preset": "cartGoal"
}
}Успешное сохранение возвращает 200 OK с объектом компонента. В режиме проверки ответ содержит validatedOnly: true, изменение не сохраняется. Для замены по известной ревизии передайте эту же структуру в PUT с revision из GET и всеми остальными полями черновика.
Предпросмотр, публикация, запуск и остановка
| Запрос | Тело | Результат |
|---|---|---|
POST /{id}/preview | {"targetUrl":"https://shop.example/cart"} | 200 OK, url и expiresAt. Откройте ссылку до её истечения. |
POST /{id}/publish | Без тела. | 200 OK, компонент с конфигурацией в published. |
PATCH /{id} | {"running":false} | 200 OK, компонент с выключенным опубликованным показом. Для включения передайте true. |
DELETE /{id} | Без тела. | 204 No Content. |
В этих примерах в {id} можно поставить d520c6eb-4a35-43cb-9afb-27d163cef099. Для предпросмотра укажите страницу своего сайта, на которой можно показать компонент. Если нужен конкретный вариант вкладки, передайте variants с section и variantId. Публикация черновика и включение показа — отдельные действия.
Как исправить ошибку
Если ревизия устарела, повторно прочитайте компонент и внесите изменения в текущий черновик. Если API отклонил поле, проверьте каталог шаблонов и ответ API управления. Поле running принимает логическое значение. Пропустите его, чтобы сохранить текущее.
Режимы показа описаны в настройке компонентов. Для передачи суммы корзины с сайта используйте registerCartUpdate.