Как получить API токен в Konso

bolt

TL;DR

check_circleAPI токен — ключ для аутентификации запросов к Konso API из вашего приложения
check_circleТокены создаются в разделе Настройки → API доступ внутри проекта
check_circleКаждый токен привязан к конкретному проекту — для разных проектов нужны разные токены
check_circleСохраните токен сразу после создания — повторно он не отображается
check_circleСкомпрометированный токен можно отозвать в любой момент без потери данных

Что такое API токен и зачем он нужен

API токен — это секретный ключ, который идентифицирует ваше приложение при обращении к Konso API. Без него платформа не сможет определить, к какому проекту относятся входящие данные. Токен передаётся в заголовке каждого запроса и используется для логирования, отправки метрик, трекинга значений и работы с CMS.

Войдите в Konso

Перейдите на app.konso.io и авторизуйтесь в своём аккаунте. Если у вас ещё нет аккаунта — зарегистрируйтесь бесплатно.

Выберите нужный проект

На главном экране выберите проект, для которого хотите получить API токен. Токен будет привязан именно к этому проекту.

Перейдите в Настройки проекта

В левом меню нажмите "Настройки". Откроется страница настроек текущего проекта. [скриншот: левое меню с выделенным пунктом Настройки]

Откройте раздел "API доступ"

В меню настроек выберите вкладку "API доступ". Здесь отображается список всех созданных токенов для проекта. [скриншот: страница API доступ с таблицей токенов]

Создайте новый токен

Нажмите кнопку "Добавить токен". В открывшемся диалоге введите понятное название — например, "Production Backend" или "Dev Environment". Нажмите "Сохранить". [скриншот: форма создания нового API токена с полем названия]

Скопируйте и сохраните токен

После создания токен будет показан один раз. Скопируйте его и сохраните в безопасном месте — в переменной окружения вашего приложения или в менеджере секретов. [скриншот: сгенерированный токен с кнопкой копирования] В следующий раз в этом разделе будет виден только prefix токена — полное значение восстановить невозможно.

Как использовать токен в запросах

Токен передаётся в HTTP заголовке x-api-key при каждом запросе к Konso API.

Как отозвать токен

Если токен был скомпрометирован или больше не нужен — удалите его в разделе "API доступ". Нажмите на иконку удаления рядом с токеном и подтвердите действие. После этого все запросы с данным токеном будут отклоняться с ошибкой 401.

Когда стоит создать отдельный токен

check_circleДля каждого окружения: development, staging, production
check_circleДля каждого микросервиса или приложения, отправляющего данные
check_circleПри передаче токена третьей стороне или подрядчику
check_circleПосле смены команды или увольнения сотрудника с доступом к токену

Готово — приступайте к интеграции

Получите API токен и подключите Konso к вашему приложению за несколько минут

Открыть Konso arrow_forward

Частые вопросы

Сколько токенов можно создать для одного проекта? expand_more

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

Что делать, если я потерял токен? expand_more

Токен показывается только один раз при создании. Если вы его потеряли — удалите старый токен и создайте новый. Данные в проекте при этом не пострадают.

Токен отличается от проекта к проекту? expand_more

Да, каждый токен привязан к конкретному проекту. Для отправки данных в разные проекты нужны соответствующие токены каждого проекта.

Можно ли ограничить права токена? expand_more

В текущей версии Konso токен предоставляет полный доступ к проекту. Гранулярное управление правами запланировано в будущих обновлениях.