REST API Notiondesk позволяет вашему собственному коду управлять вашими центрами поддержки. Вы можете получать список ваших центров поддержки, читать их статьи, подборки и журналы изменений, управлять перенаправлениями страниц, изменять настройки и фирменный стиль, получать аналитические данные и отзывы читателей, а также запускать синхронизацию из Notion.
В этой статье объясняется, что может делать API Notiondesk, кто может его использовать и как сделать свой первый запрос за несколько минут.
Что можно сделать с API Notiondesk
| Задача | Пример | Гид |
|---|---|---|
| Ознакомьтесь с информацией о ваших центрах поддержки. | Перечислите все центры справки в вашем рабочем пространстве и их языки. | Ознакомьтесь с информацией о ваших центрах поддержки. |
| Читать контент | Экспортируйте все статьи в формате Markdown или выведите список изменений. | Читайте статьи, подборки и записи об изменениях. |
| Изменения в концепции публикации | Синхронизируйте свой справочный центр из конвейера CI после редактирования Notion. | Запуск синхронизации Notion |
| Управление перенаправлениями | Импорт сотен перенаправлений после миграции из другого справочного центра. | Управление перенаправлениями страниц |
| Изменить язык | Добавьте язык или включите автоматический перевод. | Управление языками и автоматическим переводом |
| Изменить настройки | Обновите SEO-заголовки, llms.txt, форму обратной связи или список изменений. | Обновить настройки справочного центра |
| Изменение бренда | Примените фирменные цвета и тему оформления к нескольким центрам поддержки. | Настройте фирменный стиль и темы оформления. |
| Управление интеграциями | Настройте Google Analytics, Plausible, Intercom или Crisp. | Управление интеграциями |
| Аналитика запросов | Направляйте посетителей, результаты поиска и самые популярные статьи в ваш инструмент бизнес-аналитики. | Получите аналитику справочного центра |
| Прочитайте отзывы | Каждое утро отправляйте негативные реакции на статьи в Slack. | Экспорт отзывов читателей |
Готовые к использованию скрипты см. в разделе «Автоматизация распространенных задач справочного центра с помощью API Notiondesk» .
Кто может использовать API Notiondesk?
- План: Доступ к API включен в корпоративные тарифные планы.
- Создание ключей: Владельцы рабочих пространств и администраторы создают ключи API на панели управления.
- Права доступа: Ключ или приложение никогда не смогут делать больше, чем может делать человек, стоящий за ним, в вашем рабочем пространстве. См. раздел «Аутентификация с помощью API Notiondesk с использованием ключей API» .
Выполните свой первый API-запрос Notiondesk
1. Создайте ключ API.
В панели управления Notiondesk откройте «Настройки» , затем «Разработчики» > «Ключи API» и нажмите «Создать ключ» . Присвойте ему метку, выберите область действия для чтения и скопируйте ключ, когда он отобразится. Ключ начинается с nd_wsk_ и отображается только один раз.
Сохраните это в переменной окружения:
2. Перечислите ваши центры помощи.
В ответе будет перечислены все центры поддержки в вашем рабочем пространстве:
3. Перечислите статьи справочного центра.
Вот и всё! Вы читаете справочный центр прямо из кода.
Notiondesk Основы API
export NOTIONDESK_API_KEY="nd_wsk_..."curl "<https://api.notiondesk.so/sites>" \
-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
}curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"| Тема | Что нужно знать |
|---|---|
| Базовый URL | https://api.notiondesk.so |
| Аутентификация | Authorization: Bearer <key or access token>. См. ключи API и OAuth. |
| Области применения | read, write, sync и admin. Для каждого маршрута требуется один |
| Версионирование | Дополнительный заголовок nd-version |
| Формат | JSON-тела запроса и ответа с именами полей в формате snake_case |
| Пагинация | На основе курсора: page_size (от 1 до 100, по умолчанию 20) и cursor. См. раздел «Пагинация» и запросы версий. |
| Ошибки | Один JSON-конверт с машиночитаемым значением code. См. раздел «Обработка ошибок, ограничений скорости и повторных попыток». |
Notiondesk API или Workspace MCP?
Notiondesk предлагает два способа управления центрами поддержки вне панели управления. Доступ к одним и тем же функциям осуществляется через разные каналы.
| Notiondesk REST API | Рабочее пространство MCP | |
|---|---|---|
| Кто это называет? | Ваш код: скрипты, конвейеры CI, внутренние инструменты, партнерские приложения | Искусственный интеллект-помощник, такой как Claude, ChatGPT, Cursor или VS Code. |
| Как осуществляется вход в систему | Ключ API рабочей области или токен доступа OAuth. | OAuth, через ваш ИИ-клиент |
| Лучше всего подходит для | Повторяемая, детерминированная автоматизация | Работа в формате диалога: «найти статьи, которые не нравятся читателям, и предложить решения». |
Notiondesk API конечная точка
| Метод | Путь | Объем | Гид |
|---|---|---|---|
GET | /sites | read | центры помощи |
GET | /sites/{site_id} | read | центры помощи |
GET | /sites/{site_id}/sync-status | read | центры помощи |
GET | /sites/{site_id}/articles | read | Содержание |
GET | /sites/{site_id}/articles/{article_id} | read | Содержание |
GET | /sites/{site_id}/categories | read | Содержание |
GET | /sites/{site_id}/categories/{category_id} | read | Содержание |
GET | /sites/{site_id}/changelog | read | Содержание |
POST | /sites/{site_id}/sync | sync | Синхронизация |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Синхронизация |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Синхронизация |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Синхронизация |
GET | /sites/{site_id}/page-redirects | read | Перенаправления |
POST | /sites/{site_id}/page-redirects | write | Перенаправления |
PATCH | /sites/{site_id}/page-redirects/{redirect_id} | write | Перенаправления |
DELETE | /sites/{site_id}/page-redirects/{redirect_id} | admin | Перенаправления |
PATCH | /sites/{site_id}/settings/supported-languages | write | Языки |
PATCH | /sites/{site_id}/settings/auto-translate | write | Языки |
PATCH | /sites/{site_id}/settings/content | write | Настройки |
PATCH | /sites/{site_id}/settings/ai-optimization | write | Настройки |
PATCH | /sites/{site_id}/settings/contact-form | write | Настройки |
PATCH | /sites/{site_id}/settings/changelog | write | Настройки |
GET | /sites/{site_id}/settings/customize | read | Брендинг |
PATCH | /sites/{site_id}/settings/customize | admin | Брендинг |
GET | /sites/{site_id}/themes | read | Брендинг |
GET | /sites/{site_id}/integrations | read | Интеграции |
PATCH | /sites/{site_id}/integrations/{type} | admin | Интеграции |
POST | /sites/{site_id}/integrations/{type}/disable | admin | Интеграции |
GET | /sites/{site_id}/analytics/{report} | read | Аналитика |
GET | /sites/{site_id}/feedback | read | Обратная связь |
Часто задаваемые вопросы
Могу ли я создавать или редактировать статьи с помощью API Notiondesk?
Нет. Статьи, коллекции и записи в журнале изменений создаются в Notion, и каждая синхронизация перезаписывает данные, хранящиеся в Notiondesk. Отредактируйте страницу Notion с помощью редактора Notion или API Notion, а затем вызовите триггер синхронизации , чтобы опубликовать изменения.
Подойдет ли один API-ключ для всех моих центров поддержки?
Да. Ключ API рабочей области работает для каждого центра поддержки в своей рабочей области. В каждом запросе в пути указывается название центра поддержки, например, /sites/{site_id}/articles.
Где я могу найти site_id в справочном центре?
site_id в справочном центре?Для получения списка ваших центров поддержки с их идентификаторами id используйте команду GET /sites. Этот идентификатор также следует за /s/ в адресной строке вашей панели управления.