Аутентификация
Аутентификация запросов Fish Audio Open API.
Аутентификация
Запросы Fish Audio Open API используют ключи носителя API. Ключ API идентифицирует учетную запись, область разрешений, квоту и контекст выставления счетов для запроса.
Authorization: Bearer FISHAUDIO_API_KEYСоздавайте ключи API и управляйте ими в своей учетной записи:
https://fishaudio.org/en/account?section=apiПравила запроса
Каждый запрос Open API должен включать заголовок Authorization. Запросы JSON также должны включать Content-Type: application/json. Конечные точки, состоящие из нескольких частей, должны позволять вашему клиенту HTTP устанавливать границу из нескольких частей.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"Не отправляйте ключи API из браузера JavaScript, мобильных приложений, общедоступных репозиториев, журналов, событий аналитики или сообщений об ошибках, видимых для клиента. Считайте ключ API паролем для вашей рабочей учетной записи.
API Хранилище ключей
Сохраните ключ API в диспетчере секретов на стороне сервера или в зашифрованной переменной среды. Загрузите его при запуске процесса и передайте только клиенту HTTP, который взаимодействует с Fish Audio. Если вы запускаете фоновые рабочие процессы, передайте им тот же секретный ключ через платформу развертывания, а не копируйте его в полезные данные задания.
Меняйте ключи API, когда член команды уходит, когда в журнале сборки может быть раскрыт секрет или когда вы перемещаете интеграцию из промежуточной версии в рабочую. После ротации сначала разверните новый ключ API, проверьте трафик, а затем отзовите старый ключ API.
Ответ и обработка ошибок
Ошибки аутентификации возвращают ошибки JSON, когда запрос достигает уровня API.
| Статус | Значение | Действие |
|---|---|---|
401 | Ключ API отсутствует, имеет неверный формат, отозван или принадлежит отключенной учетной записи | Остановить повторные попытки и обновить настроенный ключ API |
402 | Кредитов или квоты API недостаточно | Предложить владельцу счета пополнить или уменьшить размер пакета |
429 | Запрос ограничен по скорости | Повторите попытку с отсрочкой и по возможности сохраните исходный идентификатор задания |
Зарегистрируйте requestId из ответов об ошибках. Это позволяет службе поддержки найти точный запрос, не прося вас поделиться ключами API или необработанными полезными данными.
Выставление счетов и кредиты
Сама аутентификация не потребляет кредиты. Конечные точки мультимедиа, прошедшие проверку подлинности, могут резервировать или потреблять кредиты в зависимости от конечной точки. Таким образом, действительный ключ API не гарантирует, что запрос на создание будет успешным; ваше приложение должно отдельно обрабатывать ошибки баланса и квоты.