API Notiondesk позволяет изменять настройки вашего справочного центра непосредственно из кода: индексацию поисковыми системами, заголовок и описание страницы на каждом языке, оптимизацию с помощью ИИ, форму обратной связи и список изменений. Используйте его для применения одной и той же конфигурации к нескольким справочным центрам или для управления версиями настроек.
| Метод | Путь | Объем | Изменения |
|---|---|---|---|
PATCH | /sites/{site_id}/settings/content | write | Индексирование поисковыми системами, заголовок и описание страницы по языкам. |
PATCH | /sites/{site_id}/settings/ai-optimization | write | llms.txt, экспорт в формат Markdown и контекстное меню ИИ |
PATCH | /sites/{site_id}/settings/contact-form | write | Отображается ли форма обратной связи |
PATCH | /sites/{site_id}/settings/changelog | write | Список изменений и его параметры |
Языки и автоматический перевод описаны в отдельной статье: Управление языками и автоматическим переводом с помощью API Notiondesk . Цвета, шрифты и макеты описаны в разделе «Настройка фирменного стиля и тем справочного центра с помощью API Notiondesk» .
Как работают обновления настроек
Все маршруты на этой странице подчиняются одним и тем же правилам:
- Отправлять только то, что вы изменили. Поле, которое вы не указали, сохраняет свое текущее значение.
- Ответ —
204 No Content, без тела, даже если ничего не изменилось. Прочитайте новое состояние с помощьюGET /sites/{site_id}, как описано в разделе «Чтение справочных центров с помощью API Notiondesk» .
- Отправляйте логические значения в формате JSON. Только значения
trueилиfalse: значения0и"false"считываются какtrue.
- Неизвестные поля отклоняются с кодом ошибки 400
validation_error, и ничего не меняется.
- Повторные попытки безопасны при использовании
Idempotency-Key. См. раздел «Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток» .
Индексирование поисковыми системами, заголовки и описания страниц.
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/content" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"seo_indexing_enabled": true, "items": [{"locale": "fr", "page_title": "Centre d aide Example", "page_description": "Toutes les réponses sur Example"}]}'| Поле | Тип | Примечания | Прочитайте в обратном порядке |
|---|---|---|---|
seo_indexing_enabled | логический | Будут ли поисковые системы индексировать справочный центр? | seo_indexing_enabled |
items | список объектов | Для каждого языка можно изменить один объект. | setting_content_items |
Каждый объект в items:
| Поле | Тип | Примечания |
|---|---|---|
locale | нить | Обязательно. Язык, используемый справочным центром, не более одного языка из списка. |
page_title | строка или null | До 255 символов. null очищает это поле. |
page_description | строка или null | До 255 символов. null очищает это поле. |
Объект изменяет только те поля, которые он содержит, а язык, который вы исключаете из items, сохраняет свое название и описание. items не может добавлять или удалять язык.
Ошибка в указании языка в пути к полю приводит, например, к слову items[fr].page_title.
seo_indexing_enabled: false Этот запрос требует от поисковых систем прекратить индексирование всего вашего справочного центра. См. раздел «Запрет поисковым системам сканировать и индексировать ваш справочный центр» .Оптимизация с помощью ИИ
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/ai-optimization" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"llms_txt_enabled": true, "markdown_export_enabled": true, "ai_contextual_menu_enabled": true}'| Поле | Тип | Прочитайте в обратном порядке |
|---|---|---|
llms_txt_enabled | логическое значение: публикует ли справочный центр llms.txt | llms_txt_enabled |
markdown_export_enabled | логическое значение: можно ли читать статьи в формате Markdown. | markdown_export_enabled |
ai_contextual_menu_enabled | логическое значение: отображает ли статья контекстное меню ИИ. | ai_contextual_menu_enabled |
Ваш план должен включать оптимизацию с помощью ИИ. Узнайте, для чего нужна каждая функция, в разделе «Настройка оптимизации с помощью ИИ» в вашем справочном центре и в разделе «Введение в геооптимизацию/оптимизацию с помощью ИИ» .
Форма обратной связи
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/contact-form" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"enabled": false}'| Поле | Тип | Прочитайте в обратном порядке |
|---|---|---|
enabled | логическое значение: отображает ли справочный центр форму обратной связи. | contact_form_enabled |
- API включает или выключает форму, и ничего больше. Адреса, на которые поступают отправленные данные, задаются в панели управления. Сообщение с кодом
destination_emailsотвечает кодом 400validation_errorи ничего не меняет.
- Форма остается активной только при наличии сохраненного адреса. Включение ее для справочного центра без адреса приводит к ошибке 400
validation_errorдляdestination_emails. Сначала укажите адрес в панели управления. Для отключения формы адрес не требуется.
- Ваш тарифный план должен включать расширенные возможности настройки, в том числе и отключение формы.
Список изменений
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/changelog" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"enabled": true, "reactions_enabled": true, "changelog_categories": [{"category_id": "2984612035", "color": "blue_sky"}]}'| Поле | Тип | Примечания | Прочитайте в обратном порядке |
|---|---|---|---|
enabled | логический | Опубликован ли список изменений | changelog_enabled |
email_subscriptions_enabled | логический | Можно ли подписаться на рассылку уведомлений об изменениях по электронной почте? true нуждается в тарифном плане с уведомлениями об изменениях по электронной почте. | changelog_email_subscriptions_enabled |
reactions_enabled | логический | Возможность реакции читателей на записи в журнале изменений. | changelog_reactions_enabled |
email_subject_pattern | нить | Тема электронных писем с журналом изменений, до 255 символов. Её нельзя удалить: null и "" оставляют её без изменений. | changelog_email_subject_pattern |
changelog_categories | список объектов | Полный набор коллекций журналов изменений | changelog_categories |
Каждый объект в changelog_categories имеет обязательный category_id, id одной из ваших коллекций и необязательный color длиной до 255 символов.
changelog_categories Заменяет весь набор. Если вы исключите какую-либо коллекцию, она перестанет быть коллекцией списка изменений, и все остальные коллекции будут удалены. Если вы хотите добавить только одну коллекцию, читайте с самого начала. Набор вмещает до 100 коллекций.[]changelog_categoriesGET /sites/{site_id}Ваш тарифный план должен включать журнал изменений. Если подписка на рассылку по электронной почте включена, но ваш тарифный план больше не включает уведомления об изменениях по электронной почте, каждый запрос к этому маршруту будет возвращать ошибку 403 permission_denied до тех пор, пока не будет отправлено уведомление "email_subscriptions_enabled": false.
Подробнее об этом можно узнать в разделах «Настройка журналов изменений» в вашем справочном центре и «Как включить подписку на рассылку журналов изменений по электронной почте» .
Ошибки
| Статус | Когда | code |
|---|---|---|
| 400 | Значение недопустимо или слишком длинное, язык или коллекция неизвестны или повторяются, более 100 коллекций из журнала изменений, отправлено destination_emails, форма обратной связи останется открытой без адреса, или в тексте формы содержится неизвестное поле. | validation_error |
| 403 | Ключ не имеет области видимости write | insufficient_scope |
| 403 | В ваш тарифный план не включена следующая функция (оптимизация с помощью ИИ, расширенная настройка, журнал изменений или уведомления об изменениях по электронной почте), или создатель ключа не может изменить этот справочный центр. | permission_denied |
| 404 | Центр поддержки отсутствует в вашем рабочем пространстве. | not_found |
См. раздел «Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток» для получения информации о коде ошибки и других кодах.
Часто задаваемые вопросы
Как подтвердить изменение настроек?
Прочитайте GET /sites/{site_id}. В столбце «Считать обратно как» каждого поля выше указано, где появится новое значение.
Можно ли изменить адреса электронной почты в контактной форме с помощью API?
Нет. Настройте их на панели управления. API только включает или выключает форму.
Можно ли включить поиск MCP с помощью API?
Нет. Включите поиск MCP на панели управления. API отображает его состояние в mcp_search_enabled. См. раздел «Включение поиска MCP» .
Можно ли изменить режим доступа к справочному центру с помощью API?
Нет. Доступ к общедоступным, паролем и гостевым учетным записям задается на панели управления. API отображает текущий режим в access_mode.