Autenticación
Autenticar solicitudes Fish Audio Open API.
Autenticación
Las solicitudes Fish Audio Open API utilizan claves portadoras API. La clave API identifica la cuenta, el alcance del permiso, la cuota y el contexto de facturación de la solicitud.
Authorization: Bearer FISHAUDIO_API_KEYCree y administre claves API en su cuenta:
https://fishaudio.org/en/account?section=apiSolicitar reglas
Cada solicitud Open API debe incluir el encabezado Authorization. Las solicitudes JSON también deben incluir Content-Type: application/json. Los puntos finales multiparte deberían permitir que su cliente HTTP establezca el límite multiparte.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"No envíe claves API desde el navegador JavaScript, aplicaciones móviles, repositorios públicos, registros, eventos de análisis o mensajes de error visibles para el cliente. Trate la clave API como una contraseña para su cuenta de producción.
API Almacenamiento de claves
Almacene la clave API en un administrador secreto del lado del servidor o en una variable de entorno cifrada. Cárguelo al inicio del proceso y páselo solo al cliente HTTP que se comunica con Fish Audio. Si ejecuta trabajadores en segundo plano, proporcione a los trabajadores el mismo secreto a través de su plataforma de implementación en lugar de copiarlo en las cargas útiles del trabajo.
Gire las claves API cuando un miembro del equipo se vaya, cuando un registro de compilación pueda haber expuesto un secreto o cuando mueva una integración de etapa de prueba a producción. Después de la rotación, primero implemente la nueva clave API, verifique el tráfico y luego revoque la antigua clave API.
Respuesta y manejo de errores
Los errores de autenticación devuelven errores JSON cuando la solicitud llega a la capa API.
| Estado | Significado | Acción |
|---|---|---|
401 | Falta la clave API, está mal formada, está revocada o pertenece a una cuenta deshabilitada | Detenga los reintentos y actualice la clave API configurada |
402 | Los créditos o la cuota API son insuficientes | Solicitar al propietario de la cuenta que recargue o reduzca el tamaño del lote |
429 | La solicitud tiene tarifa limitada | Vuelva a intentarlo con retroceso y mantenga la identificación del trabajo original cuando sea posible |
Registre requestId a partir de respuestas de error. Permite al soporte localizar la solicitud exacta sin pedirle que comparta claves API o cargas útiles sin procesar.
Facturación y créditos
La autenticación en sí no consume créditos. Los puntos finales de medios autenticados pueden reservar o consumir créditos según el punto final. Por lo tanto, una clave API válida no garantiza que una solicitud de generación se realice correctamente; su aplicación debe manejar por separado los errores de saldo y cuota.