Autenticação
Autentique solicitações Fish Audio Open API.
Autenticação
As solicitações Fish Audio Open API usam chaves portadoras API. A chave API identifica a conta, o escopo da permissão, a cota e o contexto de cobrança da solicitação.
Authorization: Bearer FISHAUDIO_API_KEYCrie e gerencie chaves API em sua conta:
https://fishaudio.org/en/account?section=apiRegras de solicitação
Cada solicitação Open API deve incluir o cabeçalho Authorization. As solicitações JSON também devem incluir Content-Type: application/json. Os pontos de extremidade multipartes devem permitir que seu cliente HTTP defina o limite multipartes.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"Não envie chaves API do navegador JavaScript, aplicativos móveis, repositórios públicos, logs, eventos analíticos ou mensagens de erro visíveis ao cliente. Trate a chave API como uma senha para sua conta de produção.
Armazenamento de chaves API
Armazene a chave API em um gerenciador de segredos do lado do servidor ou em uma variável de ambiente criptografada. Carregue-o no início do processo e passe-o apenas para o cliente HTTP que se comunica com o Fish Audio. Se você executar trabalhadores em segundo plano, forneça aos trabalhadores o mesmo segredo por meio de sua plataforma de implantação, em vez de copiá-lo em cargas úteis de trabalho.
Gire as chaves API quando um membro da equipe sai, quando um log de build pode ter exposto um segredo ou quando você move uma integração da preparação para a produção. Após a rotação, implante primeiro a nova chave API, verifique o tráfego e, em seguida, revogue a chave API antiga.
Resposta e tratamento de erros
Falhas de autenticação retornam erros JSON quando a solicitação atinge a camada API.
| Estado | Significado | Ação |
|---|---|---|
401 | A chave API está ausente, malformada, revogada ou pertence a uma conta desativada | Interrompa novas tentativas e atualize a chave API configurada |
402 | Os créditos ou a cota API são insuficientes | Solicitar ao proprietário da conta para recarregar ou reduzir o tamanho do lote |
429 | A solicitação tem taxa limitada | Tente novamente com espera e mantenha o ID do trabalho original quando possível |
Registrar requestId de respostas de erro. Ele permite que o suporte localize a solicitação exata sem solicitar que você compartilhe chaves API ou cargas brutas.
Faturamento e créditos
A autenticação em si não consome créditos. Os endpoints de mídia autenticados podem reservar ou consumir créditos dependendo do endpoint. Uma chave API válida, portanto, não garante que uma solicitação de geração será bem-sucedida; seu aplicativo deve tratar separadamente erros de saldo e de cota.