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

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

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

Прежде чем начать

• Ваше рабочее пространство работает по корпоративному тарифному плану.

• Вы являетесь владельцем рабочего пространства или администратором.

Создайте ключ API Notiondesk

1. В панели управления Notiondesk нажмите «Настройки» .

2. В разделе «Рабочая область» откройте «Разработчики» , затем «Ключи API» .

3. Нажмите «Создать ключ» .

4. Введите метку , указывающую на назначение ключа, например, CI automation или Redirect import.

5. В разделе «Области действия» выберите только те области действия, которые необходимы для интеграции. См. раздел «Выбор правильных областей действия» .

6. Выберите срок действия : 30 дней , 90 дней , 1 год или без срока действия .

7. Нажмите «Создать» .

8. Нажмите «Копировать ключ» и сохраните ключ в менеджере секретов или переменных среды.

9. Нажмите « Я сохранил ключ» .

Ключ отображается только один раз. Если вы его потеряете, поверните ключ, чтобы получить новый секретный ключ.

Примечание: Если при создании ключа отображается значок замка и всплывающая подсказка «Доступно в тарифных планах с доступом к API», значит, ваш тарифный план не включает API. Нажатие на этот значок откроет варианты обновления.

Выберите подходящие прицелы

Область действия (scope) — это разрешение, прикрепленное к ключу. Каждому маршруту API Notiondesk требуется одна область действия, а ключ может содержать несколько.

Для каждой интеграции задайте минимальный набор необходимых ей областей действия:

Как роли в рабочем пространстве ограничивают использование клавиши

Клавиша никогда не выполняет больше функций, чем тот, кто её создал, в вашем рабочем пространстве.

Если роль создателя меняется, то и область действия ключа изменяется. Если создатель покидает рабочее пространство, ключ перестает работать. Управление ролями см. в разделе «Как пригласить члена команды» .

Ключ отправляется с каждым запросом.

Отправьте ключ в заголовке Authorization со схемой Bearer:

Содержимое файла 200 OK со списком ваших центров поддержки подтверждает работоспособность ключа. Один ключ подходит для каждого центра поддержки в своей рабочей области.

Аналогичный запрос на JavaScript:

А на языке Python:

Храните свой API-ключ Notiondesk в безопасности.

curl "<https://api.notiondesk.so/sites>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

const response = await fetch("<https://api.notiondesk.so/sites>", {
  headers: {
    Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
    "nd-version": "2026-10-16",
  },
});

const sites = await response.json();

import os
import requests

response = requests.get(
    "<https://api.notiondesk.so/sites>",
    headers={
        "Authorization": f"Bearer {os.environ['NOTIONDESK_API_KEY']}",
        "nd-version": "2026-10-16",
    },
)
sites = response.json()

• Храните ключи на своем сервере. Никогда не размещайте ключи в коде браузера, мобильного приложения или общедоступном репозитории.

• Храните ключи в переменных окружения или менеджере секретов, а не в исходном коде.

• Для каждой интеграции создавайте отдельный ключ с собственной меткой, чтобы можно было отозвать один ключ, не нарушая работу остальных.

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

• Меняйте ключ, когда кто-то, знавший его, покидает вашу команду.

• Проверьте столбец «Последнее использование» и аннулируйте ключи, которые никто не использует.

Повернуть или отозвать клавишу

Откройте «Настройки» > «Разработчики» > «Ключи API» и воспользуйтесь меню в конце строки с ключом.

Функция Rotate заменяет секретный ключ. Подтвердите с помощью Rotate : текущий секретный ключ немедленно перестает работать, и отображается новый секретный ключ. Немедленно обновите интеграцию. Истекший ключ нельзя повернуть; вместо этого создайте замену.

Функция Revoke навсегда отключает ключ. Подтвердите с помощью Revoke : автоматизации, использующие этот ключ, немедленно перестают работать, и это действие нельзя отменить.

Устранение неполадок аутентификации

WWW-Authenticate: Bearer error="insufficient_scope", scope="sync"

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

Что дальше?

• Начните работу с REST API Notiondesk

• Подключите ваше приложение к Notiondesk с помощью OAuth.

• Обработка ошибок API Notiondesk, ограничений скорости и повторных попыток.