Ознакомьтесь с информацией в справочных центрах по API Notiondesk

Перечислите ваши центры поддержки Notiondesk, ознакомьтесь с их доменом, языками и настройками, а также проверьте статус запланированной синхронизации Notion с помощью API Notiondesk.

2 мин чтения

API Notiondesk позволяет получить список всех центров поддержки в вашем рабочем пространстве, прочитать конфигурацию каждого центра поддержки и проверить статус его запланированной синхронизации с Notion. Начните здесь: центр поддержки id, возвращаемый этими маршрутами, — это site_id, который принимает каждый другой маршрут API Notiondesk.

В API Notiondesk справочный центр называется сайтом .

Метод Путь Объем Делает
GET/sitesreadОтображает список центров поддержки вашего рабочего пространства.
GET/sites/{site_id}readСчитывает информацию об одном справочном центре и его настройках.
GET/sites/{site_id}/sync-statusreadСчитывает запланированную синхронизацию Notion справочного центра.

Перечислите ваши центры помощи.

В список включены все центры поддержки в рабочей области, которым принадлежит ваш ключ, начиная с самых старых, с использованием постраничной навигации с параметрами page_size и cursor.

curl "https://api.notiondesk.so/sites?page_size=50" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"
{
  "object": "list",
  "data": [
    {
      "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
      "full_domain": "help.example.com",
      "enabled": true,
      "default_locale": "en",
      "locales": ["en", "fr"]
    }
  ],
  "has_more": false,
  "next_cursor": null
}
Поле Тип Значение
idнить Идентификатор центра поддержки, используемый как site_id во всех остальных путях.
full_domainстрока или null Домен, который посещают читатели: ваш собственный домен, если он активен, в противном случае — ваш поддомен Notiondesk.
enabledлогический Включен ли справочный центр?
default_localeнить Язык по умолчанию, например, en
localesсписок строк Языки, на которых работает справочный центр, отображаются по умолчанию, в пределах языковых ограничений вашего тарифного плана.

У вас несколько центров поддержки? См. раздел «Создание нескольких центров поддержки» .

Ознакомьтесь с настройками справочного центра.

В ответе описывается справочный центр и все настройки, которые может изменить API. Прочитайте его еще раз после обновления настроек, чтобы подтвердить новое состояние: маршруты настроек отвечают 204 No Content без тела ответа.

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"
{
  "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
  "full_domain": "help.example.com",
  "enabled": true,
  "default_locale": "en",
  "access_mode": "public",
  "guest_access_requires_login": true,
  "supported_locales": ["en", "fr"],
  "available_locales": ["en", "fr", "de", "es"],
  "auto_sync_enabled": true,
  "seo_indexing_enabled": true,
  "setting_content_items": [
    {"locale": "en", "page_title": "Example Help Center", "page_description": "Answers about Example"}
  ],
  "auto_translate_enabled": false,
  "auto_translate_source_locale": null,
  "llms_txt_enabled": true,
  "markdown_export_enabled": true,
  "ai_contextual_menu_enabled": false,
  "mcp_search_enabled": true,
  "contact_form_enabled": true,
  "changelog_enabled": true,
  "changelog_email_subscriptions_enabled": false,
  "changelog_reactions_enabled": true,
  "changelog_email_subject_pattern": null,
  "changelog_categories": [
    {"category_id": "2984612035", "color": "blue_sky"}
  ]
}
Поле Значение Измените это на
id, full_domain, enabled, default_locale Как указано в списке выше. __СОХРАНЕНО_86__: Языки
access_modeКто может читать справочный центр: public, password или guest_accounts Только панель управления
guest_access_requires_loginЗапрашивает ли центр поддержки гостевых учетных записей у читателей вход в систему? Только панель управления
supported_localesЯзыки, на которых работает справочный центр (по умолчанию, в первую очередь) Языки
available_localesЦентр поддержки может быть настроен для работы на любом языке. Не подлежит редактированию
auto_sync_enabledБудет ли синхронизироваться Notiondesk из Notion по расписанию? Синхронизация
seo_indexing_enabledБудут ли поисковые системы индексировать справочный центр? Настройки
setting_content_itemsЗаголовок и описание страницы для каждого языка: locale, page_title, page_description Настройки
auto_translate_enabled, auto_translate_source_locale Автоматически ли создаются отсутствующие переводы и с какого языка. Языки
llms_txt_enabled, markdown_export_enabled, ai_contextual_menu_enabled Отображается ли в справочном центре сообщение llms.txt, предлагаются ли статьи в формате Markdown и отображается ли контекстное меню ИИ. Настройки
mcp_search_enabledВключен ли публичный поиск MCP в справочном центре? Только панель управления. См. раздел «Включить поиск MCP».
contact_form_enabledОтображается ли в справочном центре форма обратной связи? Настройки
changelog_enabled, changelog_email_subscriptions_enabled, changelog_reactions_enabled, changelog_email_subject_pattern, changelog_categories Список изменений и его параметры. Каждая категория списка изменений имеет параметры category_id и color. Настройки

Проверьте статус запланированной синхронизации.

В ответ отображается тот же статус, что и на панели управления для запланированных синхронизаций:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/sync-status" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"
{
  "auto_sync_enabled": true,
  "frequency": "daily",
  "next_sync_at": "2026-10-19T06:00:00+00:00",
  "current_status": "idle",
  "recent_runs": [
    {
      "started_at": "2026-10-18T06:00:02+00:00",
      "finished_at": "2026-10-18T06:01:41+00:00",
      "status": "success",
      "message": "Synced successfully.",
      "error_category": null,
      "requires_customer_action": false
    }
  ]
}
Поле Значение
auto_sync_enabledВключена ли запланированная синхронизация
frequencydaily, every_2h, hourly или auto; null когда запланированная синхронизация отключена
next_sync_atКогда начнётся следующая запланированная синхронизация; null, если синхронизация не запланирована.
current_statusin_progress во время выполнения запланированного запуска, failed в случае сбоя последнего запуска, в противном случае idle
recent_runsСписок из 10 последних запланированных рейсов, начиная с самых новых.

Каждый запуск имеет значения started_at, finished_at (null во время выполнения и для запуска, который завершился по истечении времени ожидания), status (in_progress, success или failed), короткое значение message, а для неудачного запуска:

error_categoryЗначение
notion_connectionНапример, после разрыва соединения Notiondesk не удалось установить связь с вашим рабочим пространством Notion.
notion_configurationВаши базы данных или страницы Notion настроены не так, как ожидает Notiondesk
temporary_notion_issueВ Notion возникла временная проблема.
temporary_network_issueВременная проблема с сетью прервала запуск.
unknownЛюбая другая причина

Если requires_customer_action равно true, то следующий запуск также завершится с ошибкой, пока вы не исправите что-нибудь, например, проблему с подключением к Notion. См. раздел «Как синхронизировать ваш справочный центр с Notion» .

В статусе синхронизации отображаются только запланированные запуски. Синхронизация, запущенная через API или панель управления, не отображается в списке. См. раздел «Запуск синхронизации Notion с помощью API Notiondesk», чтобы подтвердить запуск синхронизации.recent_runs

Ошибки

Статус Когдаcode
400 В случае GET /sites: значение page_size выходит за пределы диапазона от 1 до 100, значение cursor недопустимо, или запрос содержит неизвестный параметр.validation_error
403 Ключ не имеет области видимости readinsufficient_scope
404 site_id не указывает на наличие справочного центра в вашем рабочем пространствеnot_found

Каждый маршрут также может отвечать на запросы invalid_version, authentication_error, rate_limited и internal_error. См. раздел «Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток» .

Часто задаваемые вопросы

Где я могу найти site_id в своем справочном центре?

Вызовите GET /sites: идентификатор id каждого центра поддержки совпадает с его идентификатором site_id. Он также является идентификатором после /s/ в адресной строке вашей панели управления Notiondesk.

Можно ли создать или удалить справочный центр с помощью API Notiondesk?

Нет. Создание и удаление центров поддержки осуществляется через панель управления. API считывает и настраивает уже существующие центры поддержки.

Можно ли изменить частоту синхронизации с помощью API?

Нет. API включает или выключает запланированную синхронизацию. Измените частоту на панели управления.

Почему в справочном центре отображается меньше языков, чем я указал?

locales и supported_locales предоставляются только в рамках языкового лимита вашего плана. Языки, превышающие лимит, не предоставляются.

Что дальше?

Связанные статьи

Эта страница была полезной?

Still need help? Ask us