Документация Ключи API

Ключи API

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

Выберите подходящий ключ

Ключ API принадлежит одному проекту. При создании выберите Production или Development. Полный ключ показывается только один раз; в списке видны лишь префикс и сведения о ключе.

Ключи SDK / Client можно использовать в играх и на сайтах. Их права ограничены devices:write и events:write. Пользователь может извлечь ключ из клиентского кода, поэтому не помещайте неограниченный серверный ключ в приложение, игру или открытый JavaScript.

Серверные ключи предназначены для доверенного бэкенда. В текущем API пустой список прав означает полный доступ по старому правилу; задавайте минимально необходимые права явно. Не раскрывайте серверный ключ пользователям.

Права клиентского ключа

  • devices:write — регистрация устройства, обновление активности и отключение токена
  • events:write — передача реальных событий OPENED и CLICKED

Передавайте ключ проекта в X-API-Key при вызове клиентских методов. ID проекта в URL должен соответствовать ключу.

X-API-Key: SDK_KEY

Замена и отзыв

Создайте новый ключ в разделе «Ключи API» проекта, обновите ключ у клиентов, затем отзовите старый. Отозванный ключ больше не работает. Повторно получить полный текст ключа нельзя.

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

Справочник REST API