Аутентификация
API-ключи, формат авторизации и рекомендации по безопасности.
Формат API-ключа
Все запросы к Konergy API аутентифицируются с помощью API-ключей. Ключ имеет формат:
sk_konergy_{publicId}_{secret}| Часть | Описание |
|---|---|
sk_konergy_ | Фиксированный префикс |
publicId | 8-символьный публичный идентификатор ключа |
secret | 32-символьная секретная часть |
API-ключ является opaque bearer token. Сервер определяет биллинговый субъект (пользователь или организация) на основе ключа автоматически.
Заголовок Authorization
Передавайте ключ в HTTP-заголовке Authorization:
Authorization: Bearer sk_konergy_aBcD1234_your32charsecretkeyherexxxxxxxxЗаголовок обязателен для всех запросов. Запросы без валидного ключа получат ошибку 401 UNAUTHORIZED.
Типы ключей
Персональные ключи
Привязаны к вашему аккаунту. Все расходы списываются с вашего личного кошелька.
- Максимум 10 активных ключей на пользователя
- Управление:
POST /api-keys/personal,POST /api-keys/personal/:id/revoke
Ключи организации
Привязаны к организации. Расходы списываются с кошелька организации. Могут быть ограничены ежемесячным лимитом расходов (spend limit).
- Максимум 50 активных ключей на организацию
- Создать ключ могут только owner и admin
- Управление:
POST /organizations/:orgId/api-keys,POST /organizations/:orgId/api-keys/:id/revoke
Жизненный цикл ключа
- Создание — ключ генерируется, секретная часть показывается один раз
- Использование — передавайте ключ в каждом запросе через заголовок Authorization
- Ротация — создайте новый ключ, обновите все интеграции, отзовите старый
- Отзыв —
POST /api-keys/personal/:id/revoke. Отозванный ключ немедленно перестаёт работать
Рекомендации по безопасности
- Никогда не коммитьте ключи в систему контроля версий
- Используйте переменные окружения:
KONERGY_API_KEY=sk_konergy_... - Регулярно ротируйте ключи — создавайте новый, переключайте интеграции, отзывайте старый
- Используйте разные ключи для разных сред (dev, staging, production)
- Для организаций устанавливайте лимиты расходов, чтобы контролировать бюджет
- Отзывайте неиспользуемые ключи
Общие заголовки запросов
| Заголовок | Обязательный | Описание |
|---|---|---|
Authorization | Да | Bearer sk_konergy_... |
Content-Type | Да (POST/PUT/PATCH) | application/json |
Idempotency-Key | Да (POST/PUT/PATCH/DELETE) | UUIDv4, обязателен для мутаций. Ошибка 400 IDEMPOTENCY_KEY_REQUIRED при отсутствии |
Accept | Нет | application/json (по умолчанию) |