Справочник API

Каждая конечная точка API Notiondesk с ее параметрами, ответами и примерами кода.

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

Базовый URL

Все запросы отправляйте на https://api.notiondesk.so. Пути к конечным точкам начинаются с /sites, а запросы и ответы используют формат JSON.

Аутентификация

Каждый запрос содержит токен носителя в заголовке Authorization:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • Ключ API : для ваших собственных скриптов, запланированных заданий и CI. Владелец рабочей области или администратор создает его в разделе «Настройки» > «Разработчики» > «Ключи API». Ключи начинаются с nd_wsk_ и работают для всех центров поддержки в рабочей области. См. раздел «Аутентификация с помощью API Notiondesk с использованием ключей API» .

Для каждой конечной точки требуется одна область действия: read, write, sync или admin. На странице каждой конечной точки указано, какая именно.

Примеры кода

На каждой странице конечной точки отображаются ее параметры, тело запроса и ответы, а также готовые к копированию примеры кода на cURL, JavaScript и Python.

Гиды

  • Веб-хуки : получают запрос на свой сервер, когда что-то происходит в Notiondesk.