VARICA
digital proposal bureau
VARICA / Документация v2

Page slug в v2

Как работает page_slug, когда его передавать, какие ограничения у значения и что делает сервис, если slug не был указан.

МетодGUIDE Endpointpage_slug АвторизацияСправка Вход- ВыходHTML
01 / Раздел

Что такое page_slug

Page slug — это короткий идентификатор страницы, который используется в сохранённой записи страницы и возвращается в ответе API.

Поле `page_slug` во внешнем методе создания страницы не является обязательным. Если его не передать, сервис сгенерирует slug сам.

02 / Раздел

Когда передавать свой slug

  • Когда внешняя система хочет сама управлять понятным идентификатором страницы.
  • Когда slug потом будет использоваться во внешних логах, CRM или интеграционных сценариях.
  • Когда нужно повторно связать внешний объект и созданную страницу через человекочитаемый идентификатор.
03 / Раздел

Ограничения

  • Длина: от 3 до 64 символов.
  • Разрешены только строчные латинские буквы, цифры, `_` и `-`.
  • Slug должен начинаться и заканчиваться буквой или цифрой.
  • Пробелы запрещены.
  • Зарезервированные системные слова использовать нельзя.
04 / Раздел

Примеры

  • Корректно: `zinker_offer_9999999`
  • Корректно: `deal-125-kp`
  • Некорректно: `Моё КП`
  • Некорректно: `offer page`
  • Некорректно: `docs`
05 / Раздел

Если slug уже занят

Во внешнем API v2 slug не перезаписывается автоматически. Если такой slug уже существует у этой организации, сервис вернёт ошибку.

Пример ошибки
{
  "detail": {
    "message": "Page slug is already taken",
    "page_slug": "zinker_offer_9999999"
  }
}
06 / Раздел

Если slug не передан

Сервис сам генерирует значение и возвращает его в ответе метода создания страницы. Дальше этот slug можно сохранить во внешней системе и использовать как часть связки.

07 / Раздел

Для ИИ и интегратора

Краткая инструкция
page_slug необязателен.
Если передаёшь его сам, используй только lowercase latin, digits, underscore, hyphen.
Длина 3-64.
Если slug уже занят, сервис вернёт ошибку и новый slug сам не придумает.