База для разработчиков
База для разработчиков — отдельная документация: API, вебхуки, примеры интеграций. У неё свой адрес, своё оформление и свои права доступа, а во вкладке «Помощь» виджета на сайте её нет.
Где найти
База знаний → переключатель над деревом → «База для разработчиков»
Как вести документацию
Откройте «Базу знаний» и выберите в переключателе над деревом «База для разработчиков».
База для разработчиков «Зерно API»: 1 — переключатель баз, 2 — база ещё не опубликована, 3 — разделы документации Создавайте разделы и статьи так же, как в клиентской базе, — см. Разделы и порядок статей и Написать статью. Для запросов и ответов API подойдут блоки «Код» и «Таблица».
Опубликуйте статьи, а потом и саму базу — кнопкой «Опубликовать» в карточке над деревом.
Оформление и адрес — «Настройки → Знания → База знаний», вкладка «Для разработчиков». По умолчанию у документации шаблон «Документация»: дерево разделов слева и оглавление справа.
Настройки базы для разработчиков: 1 — вкладка «Для разработчиков», 2 — шаблон «Документация»
Что получится
Документация откроется по своему адресу — <имя>.dev.deskus.space — с заголовком «Документация» и поиском «Найдите метод, вебхук или пример…». В шаблоне «Документация» слева — дерево «Разделы документации», а на телефоне оно сворачивается в список «Все разделы».
Полезно знать
Отдельное право
Видеть базу может только сотрудник с правом «База для разработчиков → Просмотр» — без него её нет ни в переключателе, ни в настройках. Писать и публиковать — «Изменение», переносить статьи с сайта и из файлов — «Создание» вместе с «Изменением», удалять — «Удаление». В готовых ролях «Сотрудник поддержки» и «Менеджер» этого права нет — его выдают отдельно, см. Роли и доступы.
Видимость статьи — «Все» («Сайт документации и поиск по нему») или «Только по ссылке». «Только в виджете» здесь нет: в базе для разработчиков виджета нет.
«Предпросмотр» показывает статью так, как её увидят читатели документации.
Свой домен подключается так же, как у клиентской базы, — например, docs.вашсайт.ru. См. Свой домен.
Импорт и экспорт — на странице «Импорт и экспорт»: выберите в списке «База знаний» вариант «База для разработчиков». См. Импорт статей с сайта и из файлов и Экспорт базы знаний.
Снять документацию с публикации — «…» в карточке → «Снять с публикации»: она станет недоступна по ссылке, статьи останутся в кабинете.
Если подключён ИИ-ассистент Нейтрон, он отвечает клиентам и по опубликованной документации — по статьям с видимостью «Все»: в чате, мессенджерах и почте, в ИИ-поиске справочного центра и самой документации, во вкладке «Помощь» виджета. Статья документации под ответом открывается на сайте документации — на вашем домене, если он подключён. См. Нейтрон отвечает клиентам по базе знаний.
Закрытую документацию и статьи «Только по ссылке» Нейтрон клиентам не показывает: по ним он отвечает только сотрудникам в разговоре «Нейтрон» в «Диалоге» — тем, у кого есть право «База для разработчиков → Просмотр».