Public API v1

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

REST API для получения контента, CRM-данных и embed-форм. Ниже — примеры запросов и типичные JSON-ответы.

Ключи API создаются в админке → API-ключи. Персонализированные примеры с slug вашего проекта — в документации для проекта.

Базовые сведения

Базовый URL: http://localhost:3000/api/v1
Проект в пути: /projects/your-project-slug/…(slug или id)
Авторизация: Authorization: Bearer cms_…— для большинства эндпоинтов. Меню, site и metrika — без ключа.
Заголовки: Accept: application/vnd.cms.v1+json
Content-Type: application/json — для POST/PATCH
Rate limit: GET: 100/минPOST/PATCH: 30/минX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Формат ответа

Все ответы — JSON с полем success. При успехе — data, при ошибке — error и code.

Успех

{
  "success": true,
  "data": {
    "…": "полезная нагрузка"
  }
}

Ошибка 401

{
  "success": false,
  "error": "Unauthorized",
  "code": 401
}

Ошибка 404

{
  "success": false,
  "error": "Меню не найдено",
  "code": 404
}

Ошибка 429

{
  "success": false,
  "error": "Превышен лимит запросов. Повторите позже.",
  "code": 429
}

GET/api/v1/projects/{projectSlug}/postsAPI-ключ (Bearer)

Список постов

Опубликованные посты проекта с пагинацией.

Query-параметры

limit — Размер страницы (1–100) (по умолчанию: 20)
offset — Смещение (по умолчанию: 0)
sort — Сортировка: asc | desc (по умолчанию: desc)
search — Поиск (если поддерживается)
categorySlug — Фильтр по категории
tagSlug — Фильтр по тегу (посты)

GET http://localhost:3000/api/v1/projects/your-project-slug/posts?limit=10&offset=0&sort=desc
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/posts/{postSlug}API-ключ (Bearer)

Пост по slug

Один опубликованный пост.

GET http://localhost:3000/api/v1/projects/your-project-slug/posts/my-post
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/pagesAPI-ключ (Bearer)

Список страниц

Опубликованные страницы.

Query-параметры

limit — Размер страницы (1–100) (по умолчанию: 20)
offset — Смещение (по умолчанию: 0)
sort — Сортировка: asc | desc (по умолчанию: desc)
search — Поиск (если поддерживается)
categorySlug — Фильтр по категории
tagSlug — Фильтр по тегу (посты)

GET http://localhost:3000/api/v1/projects/your-project-slug/pages?limit=10&offset=0&sort=desc
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/pages/{pageSlug}API-ключ (Bearer)

Страница по slug

Одна опубликованная страница.

GET http://localhost:3000/api/v1/projects/your-project-slug/pages/about
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/categoriesAPI-ключ (Bearer)

Категории

Список категорий и дерево.

Query-параметры

limit — Размер страницы (1–100) (по умолчанию: 20)
offset — Смещение (по умолчанию: 0)
sort — Сортировка: asc | desc (по умолчанию: desc)
search — Поиск (если поддерживается)

GET http://localhost:3000/api/v1/projects/your-project-slug/categories?limit=10&offset=0&sort=desc
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/categories/{categorySlug}API-ключ (Bearer)

Категория по slug

Одна категория.

GET http://localhost:3000/api/v1/projects/your-project-slug/categories/news
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/tagsAPI-ключ (Bearer)

Тег по slug

Один тег.

GET http://localhost:3000/api/v1/projects/your-project-slug/tags/promo
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/menusAPI-ключ (Bearer)

Список меню

Ключи и метаданные меню.

GET http://localhost:3000/api/v1/projects/your-project-slug/menus
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/menus/{menuKey}Без ключа

Дерево меню

Пункты меню для встраивания на сайт. Bearer не обязателен.

Публичный доступ для фронтенда сайта.

GET http://localhost:3000/api/v1/projects/your-project-slug/menus/main
Accept: application/vnd.cms.v1+json

POST/api/v1/projects/{projectSlug}/subscribeAPI-ключ (Bearer)

Подписка email

Создание подписчика (дубликат email — ошибка).

POST http://localhost:3000/api/v1/projects/your-project-slug/subscribe
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

{
  "email": "user@example.com",
  "name": "Иван",
  "gdprConsent": true,
  "source": "landing"
}

GET/api/v1/projects/{projectSlug}/subscribersAPI-ключ (Bearer)

Список подписчиков

Подписчики с пагинацией.

Query-параметры

limit — Размер страницы (1–100) (по умолчанию: 20)
offset — Смещение (по умолчанию: 0)
sort — Сортировка: asc | desc (по умолчанию: desc)
search — Поиск (если поддерживается)

GET http://localhost:3000/api/v1/projects/your-project-slug/subscribers?limit=10&offset=0&sort=desc
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/subscribers/{subscriberId}API-ключ (Bearer)

Подписчик по id

Одна запись подписчика.

GET http://localhost:3000/api/v1/projects/your-project-slug/subscribers/clxxxxxxxxxxxxxxxx
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

PATCH/api/v1/projects/{projectSlug}/subscribers/{subscriberId}API-ключ (Bearer)

Обновить подписчика

Частичное обновление email, имени, source.

PATCH http://localhost:3000/api/v1/projects/your-project-slug/subscribers/clxxxxxxxxxxxxxxxx
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

{
  "name": "Иван Петров",
  "source": "api"
}

GET/api/v1/projects/{projectSlug}/leadsAPI-ключ (Bearer)

Список заявок

Заявки CRM с фильтрами.

Query-параметры

limit — Размер страницы (1–100) (по умолчанию: 20)
offset — Смещение (по умолчанию: 0)
sort — Сортировка: asc | desc (по умолчанию: desc)
search — Поиск (если поддерживается)
statusId — Фильтр по статусу заявки (cuid)

GET http://localhost:3000/api/v1/projects/your-project-slug/leads?limit=10&offset=0&sort=desc
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

POST/api/v1/projects/{projectSlug}/leadsAPI-ключ (Bearer)

Создать заявку

Новая заявка или обновление по номеру телефона (дедупликация).

POST http://localhost:3000/api/v1/projects/your-project-slug/leads
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

{
  "name": "Иван",
  "phone": "+79991234567",
  "email": "ivan@example.com",
  "comment": "Интересует услуга",
  "utmSource": "yandex",
  "source": "api"
}

GET/api/v1/projects/{projectSlug}/leads/{leadId}API-ключ (Bearer)

Заявка по id

Одна заявка.

GET http://localhost:3000/api/v1/projects/your-project-slug/leads/clxxxxxxxxxxxxxxxx
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

PATCH/api/v1/projects/{projectSlug}/leads/{leadId}API-ключ (Bearer)

Обновить заявку

Статус, контакты, UTM-поля.

PATCH http://localhost:3000/api/v1/projects/your-project-slug/leads/clxxxxxxxxxxxxxxxx
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

{
  "statusId": "clxxxxxxxxxxxxxxxx",
  "comment": "Перезвонить завтра"
}

GET/api/v1/projects/{projectSlug}/clientsAPI-ключ (Bearer)

Список клиентов

Клиенты проекта (read-only через API).

Query-параметры

limit — Размер страницы (1–100) (по умолчанию: 20)
offset — Смещение (по умолчанию: 0)
sort — Сортировка: asc | desc (по умолчанию: desc)
search — Поиск (если поддерживается)

GET http://localhost:3000/api/v1/projects/your-project-slug/clients?limit=10&offset=0&sort=desc
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/clients/{clientId}API-ключ (Bearer)

Клиент по id

Карточка клиента.

GET http://localhost:3000/api/v1/projects/your-project-slug/clients/clxxxxxxxxxxxxxxxx
Authorization: Bearer cms_ВАШ_КЛЮЧ
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/siteБез ключа

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

Публичный брендинг и SEO: siteUrl, логотип, Open Graph, счётчик Метрики. Bearer не обязателен. slug или id проекта. Только ACTIVE.

GET http://localhost:3000/api/v1/projects/your-project-slug/site
Accept: application/vnd.cms.v1+json

GET/api/v1/projects/{projectSlug}/metrikaБез ключа

Яндекс.Метрика

Публичный конфиг счётчика и целей. Также siteUrl и seoTitle. Полный брендинг — GET /site.

GET http://localhost:3000/api/v1/projects/your-project-slug/metrika
Accept: application/vnd.cms.v1+json

OPTIONS/api/v1/embed/projects/{projectSlug}/leadsEmbed + CORS

CORS preflight (заявка)

Проверка origin из whitelist embed.

OPTIONS http://localhost:3000/api/v1/embed/projects/your-project-slug/leads
Origin: https://example.com

POST/api/v1/embed/projects/{projectSlug}/leadsEmbed + CORS

Заявка через embed

Форма с чужого сайта. Origin в whitelist, rate limit, honeypot.

Не используйте API-ключ. Настройте домены в разделе Embed.

POST http://localhost:3000/api/v1/embed/projects/your-project-slug/leads
Origin: https://example.com
Content-Type: application/json

{
  "name": "Иван",
  "phone": "+79991234567",
  "comment": "С виджета"
}

OPTIONS/api/v1/embed/projects/{projectSlug}/subscribeEmbed + CORS

CORS preflight (подписка)

Проверка origin из whitelist embed.

OPTIONS http://localhost:3000/api/v1/embed/projects/your-project-slug/subscribe
Origin: https://example.com

POST/api/v1/embed/projects/{projectSlug}/subscribeEmbed + CORS

Подписка через embed

Email-подписка с чужого сайта.

POST http://localhost:3000/api/v1/embed/projects/your-project-slug/subscribe
Origin: https://example.com
Content-Type: application/json

{
  "email": "user@example.com",
  "name": "Иван",
  "gdprConsent": true,
  "source": "embed"
}

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

Базовые сведения

Формат ответа

Список постов

Пост по slug

Список страниц

Страница по slug

Категории

Категория по slug

Теги

Тег по slug

Список меню

Дерево меню

Подписка email

Список подписчиков

Подписчик по id

Обновить подписчика

Список заявок

Создать заявку

Заявка по id

Обновить заявку

Список клиентов

Клиент по id

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

Яндекс.Метрика

CORS preflight (заявка)

Заявка через embed

CORS preflight (подписка)

Подписка через embed