Ключи API

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

Передача ключа

Передавайте ключ в заголовке Authorization: Bearer …. Для Messages также доступен x-api-key; используйте один из этих заголовков. Веб-сессия не авторизует запросы API. Передача ключа в адресе запроса запрещена.

bash

curl "https://api.renderfox.ru/v1/models" -H "Authorization: Bearer $RENDERFOX_API_KEY"

Лимиты и срок действия

Ключи из кабинета получают права на доступные операции API. В каждом запросе проверяются владелец, срок действия, лимиты и возможности модели. Ключ API не даёт доступа к управлению аккаунтом, другими ключами или платежами.

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

Создание, замена и удаление

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

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

Удаление отзывает ключ и убирает его из списка. Новые запросы и дальнейшая выдача потока по нему запрещены. Уже принятые задания завершают расчёт; история использования и оплаты сохраняется.

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

Безопасное хранение

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

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