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» .
- Токен доступа OAuth : для приложений, к которым подключаются другие клиенты Notiondesk. См. раздел «Подключение вашего приложения к Notiondesk с помощью OAuth» .
Для каждой конечной точки требуется одна область действия: read, write, sync или admin. На странице каждой конечной точки указано, какая именно.
Примеры кода
На каждой странице конечной точки отображаются ее параметры, тело запроса и ответы, а также готовые к копированию примеры кода на cURL, JavaScript и Python.
Гиды
- Начните работу с REST API Notiondesk : ваш первый запрос, шаг за шагом.
- Руководства по началу работы : ключи API, OAuth, пагинация и версии, ошибки и ограничения скорости, а также примеры.
- Веб-хуки : получают запрос на свой сервер, когда что-то происходит в Notiondesk.