Управление интеграцией справочного центра с помощью API Notiondesk

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

Для настройки и отключения поставщиков услуг необходим план, включающий интеграцию.

Каждый провайдер загружает сторонний скрипт на каждую страницу вашего справочного центра. Контейнер Google Tag Manager запускает все, что публикует его владелец, а Plausible или Umami определяют, откуда загружается скрипт аналитики. Именно поэтому для изменения интеграций требуется указать область действия. Присвойте ключ только тем интеграциям, которым вы доверяете.proxy_urladminadmin

Поддерживаемые поставщики

Каждое значение представляет собой строку длиной до 255 символов. Ни одно из них не является секретом: каждый из них — это идентификатор, необходимый скрипту поставщика на странице. Notiondesk проверяет формат, но не сам идентификатор у поставщика.

Перечислите ваши интеграции

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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

Настройте поставщика услуг.

Передайте поля поставщика по указанному пути. Маршрут отвечает 200 OK с подтверждением интеграции.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

• Обновление всегда включает провайдера. Поле enabled отсутствует: чтобы отключить провайдера, используйте способ отключения.

• Поле, которое вы не указали, сохраняет свое сохраненное значение. Чтобы снова включить настроенный поставщик без его изменения, отправьте {}.

• Чтобы удалить прокси, отправьте "proxy_url": null.

• Каждое обновление обновляет весь справочный центр, очищая кэшированные страницы и перестраивая каждую страницу.

Примечание: Значение, сохраненное до применения текущих форматов, например, идентификатор Google Analytics или значение, не соответствующее текущему формату, не проходит проверку. Пока вы не отправите допустимое значение для этого поля, каждое обновление этого поставщика будет приводить к ошибке 400, включая этот код.UA-proxy_urlhttpsvalidation_error{}

Отключить провайдера

Маршрут отвечает 204 No Content, и ваш справочный центр перестает загружать поставщика услуг. Его настройки сохраняются, поэтому в списке он по-прежнему отображается с enabled: false, а {}, отправленный на маршрут обновления, снова включает его.

Отключение уже отключенного провайдера или провайдера, который никогда не был настроен, также приводит к ответу 204 и ничего не меняет, поэтому повторная попытка всегда безопасна.

Ошибки

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

См. раздел «Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток» для получения информации о коде ошибки и других кодах.

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

Что дальше?

• Получите аналитику справочного центра с помощью API Notiondesk

• Настройте фирменный стиль и темы оформления справочного центра с помощью API Notiondesk

• Аутентификация с помощью API Notiondesk осуществляется с использованием ключей API.