developer
Начните работу с REST API NotiondeskИспользуйте REST API Notiondesk для чтения содержимого справочного центра, управления перенаправлениями и настройками, получения аналитических данных и запуска синхронизации Notion из кода.
Аутентификация с помощью API Notiondesk осуществляется с использованием ключей API.Создайте ключ API Notiondesk, выберите области действия: чтение, запись, синхронизация или администрирование, и аутентифицируйте запросы REST API с помощью токена bearer. Вы можете изменить или отозвать ключ в любое время.
Подключите ваше приложение к Notiondesk с помощью OAuth.Создайте OAuth-приложение Notiondesk: зарегистрируйте клиента, запустите поток авторизации OAuth 2.0 с использованием PKCE, обновите токены и вызовите REST API.
Пагинация и версионирование запросов API NotiondeskПролистывайте списки API Notiondesk с помощью page_size и cursor, закрепите версию с помощью заголовка nd-version и используйте имена полей в формате snake_case.
Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток.Notiondesk Коды ошибок API и их обертка, ограничения скорости чтения 120 и записи 20 в минуту, функция «Повторить попытку» и безопасные повторные попытки с ключом идемпотентности.
Ознакомьтесь с информацией в справочных центрах по API NotiondeskПеречислите ваши центры поддержки Notiondesk, ознакомьтесь с их доменом, языками и настройками, а также проверьте статус запланированной синхронизации Notion с помощью API Notiondesk.
Читайте статьи, подборки и записи об изменениях с помощью API NotiondeskЧитайте статьи и подборки справочного центра Notiondesk в формате Markdown на любом языке с синхронизацией состояния и просматривайте список изменений через REST API.
Trigger Notion синхронизируется с API NotiondeskСинхронизируйте свой справочный центр Notiondesk из Notion через API: запускайте синхронизацию сайта, коллекции или статьи, а также включайте или выключайте запланированную синхронизацию.
Управление перенаправлениями страниц с помощью API NotiondeskСоздавайте, перечисляйте, обновляйте и удаляйте перенаправления страниц справочного центра Notiondesk через REST API. Импортируйте старые URL-адреса сразу после миграции.
Управление языками и автоматическим переводом с помощью API NotiondeskДобавляйте или удаляйте языки справочного центра, устанавливайте язык по умолчанию и включайте или выключайте автоматический перевод с помощью ИИ через REST API.
Обновите настройки справочного центра с помощью API NotiondeskОбновите настройки справочного центра Notiondesk через REST API: SEO-индексация, заголовки страниц, экспорт в llms.txt и Markdown, форма обратной связи и список изменений.
Настройте фирменный стиль и темы оформления справочного центра с помощью API NotiondeskОбновите фирменный стиль справочного центра Notiondesk через REST API: цвета, шрифты, макет, ссылки в заголовке и нижнем колонтитуле, отображение результатов поиска и темы оформления.
Управление интеграцией справочного центра с помощью API NotiondeskНастройте Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout и Google Tag Manager в вашем справочном центре Notiondesk через REST API.
Получите аналитику справочного центра с помощью API NotiondeskЭкспорт аналитики справочного центра Notiondesk через REST API: посетители, просмотры статей, самые популярные поисковые запросы, поисковые запросы без результатов и реакции читателей.
Экспорт отзывов читателей с помощью API NotiondeskЭкспорт отзывов о статье Notiondesk через REST API: реакции читателей, ответы на последующие вопросы, сообщения и вложения, начиная с самых новых.
Автоматизируйте стандартные задачи справочного центра с помощью API NotiondeskПримеры использования API Notiondesk: синхронизация из GitHub Actions, резервное копирование статей в формате Markdown, отправка отзывов в Slack и сообщение о результатах поиска.