Skip to content

Admin API-ключ

Admin API-ключ — это ключ, предназначенный для выполнения запросов к Kodzero API из серверного приложения с использованием административного профиля.

Для чего нужен

Admin API-ключ позволяет серверному приложению использовать стандартный REST API Kodzero в сценариях, где требуется собственная бизнес-логика.

Например:

  • выполнение сложных операций перед записью данных;
  • интеграция с внешними сервисами;
  • выполнение фоновых задач;
  • формирование отчетов и аналитики.

Создание ключа

Создать Admin API-ключ можно в разделе «Ключи API».

https://kodzero.pro/cloud/project-keys

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

Типы ключей

Тип ключаНазначение
Только чтениеВыполнение только операций чтения
Чтение и записьВыполнение операций чтения, создания, изменения и удаления данных

Рекомендации по использованию

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

Где хранить ключ

Храните Admin API-ключ только в переменных окружения серверного приложения.

env
KODZERO_ADMIN_API_KEY_READ=...
KODZERO_ADMIN_API_KEY_WRITE=...

Важно

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

Любой ключ-секрет, встроенный в клиентское приложение, потенциально может быть извлечен пользователем или злоумышленником. Используйте Admin API-ключ только в доверенной серверной среде.