Appearance
Аутентификация
Все запросы к API требуют аутентификации через API-ключ, передаваемый в заголовке Authorization.
Формат API-ключа
API-ключи имеют формат:
sk_live_<32 случайных символа>Пример: sk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ012345
Использование API-ключа
Передавайте ключ как Bearer-токен в заголовке Authorization:
bash
curl https://api.genvoice.ru/v1/api/balance \
-H "Authorization: Bearer sk_live_YOUR_API_KEY"Создание API-ключа
- Войдите в app.genvoice.ru
- Выберите рабочее пространство под логотипом в боковом меню и откройте API ключи
- Нажмите Создать ключ
- Скопируйте ключ сразу — он показывается только один раз
Внимание
Храните API-ключ в безопасном месте. Он позволяет выполнять операции за счёт пространства и работать с его общими голосами в пределах прав и лимита создателя. При компрометации немедленно отзовите ключ через панель управления.
Управление ключами
- Максимум 10 активных непросроченных ключей на рабочее пространство; общий счётчик виден всем участникам
- Владелец и администратор видят и отзывают все ключи пространства, обычный участник — только свои
- Ключ закреплён за пространством создания; переключение пространства в браузере не меняет его назначение
- Ключи можно отозвать (деактивировать) в любой момент
- Отзыв ключа необратим и вступает в силу мгновенно
- Для каждого ключа отображаются email создателя и время последнего использования
- После выхода или удаления участника его ключи в этом пространстве отзываются
Подробнее о правах и расходах: API-ключи команды.
Рекомендации по безопасности
- Никогда не коммитьте API-ключи в репозиторий
- Храните ключи в переменных окружения
- Периодически ротируйте ключи
- Используйте отдельные ключи для разных приложений
python
import os
api_key = os.environ["GENVOICE_API_KEY"]