Authentification
Authentifier les requêtes Fish Audio Open API.
Authentification
Les requêtes Fish Audio Open API utilisent les clés du support API. La clé API identifie le compte, l'étendue des autorisations, le quota et le contexte de facturation de la demande.
Authorization: Bearer FISHAUDIO_API_KEYCréez et gérez les clés API dans votre compte :
https://fishaudio.org/en/account?section=api## Règles de demande
Chaque requête Open API doit inclure l’en-tête Authorization. Les requêtes JSON doivent également inclure Content-Type: application/json. Les points de terminaison en plusieurs parties doivent permettre à votre client HTTP de définir la limite en plusieurs parties.
curl https://fishaudio.org/api/open/v1/profile \
-H "Authorization: Bearer FISHAUDIO_API_KEY"N'envoyez pas de clés API à partir du navigateur JavaScript, d'applications mobiles, de dépôts publics, de journaux, d'événements d'analyse ou de messages d'erreur visibles par le client. Traitez la clé API comme un mot de passe pour votre compte de production.
API Stockage des clés
Stockez la clé API dans un gestionnaire de secrets côté serveur ou une variable d'environnement chiffrée. Chargez-le au démarrage du processus et transmettez-le uniquement au client HTTP qui parle à Fish Audio. Si vous exécutez des travailleurs en arrière-plan, donnez-leur le même secret via votre plate-forme de déploiement plutôt que de le copier dans les charges utiles des tâches.
Faites pivoter les clés API lorsqu'un membre de l'équipe quitte, lorsqu'un journal de build peut avoir révélé un secret ou lorsque vous déplacez une intégration du stade intermédiaire vers la production. Après la rotation, déployez d'abord la nouvelle clé API, vérifiez le trafic, puis révoquez l'ancienne clé API.
Réponse et gestion des erreurs
Les échecs d'authentification renvoient des erreurs JSON lorsque la demande atteint la couche API.
| Statut | Signification | Actions |
|---|---|---|
401 | La clé API est manquante, mal formée, révoquée ou appartient à un compte désactivé | Arrêtez les tentatives et actualisez la clé API configurée |
402 | Les crédits ou le quota API sont insuffisants | Inviter le propriétaire du compte à recharger ou à réduire la taille du lot |
429 | La demande est à tarif limité | Réessayez avec interruption et conservez l'ID de tâche d'origine lorsque cela est possible |
Enregistrez requestId à partir des réponses d’erreur. Il permet à l'assistance de localiser la demande exacte sans vous demander de partager les clés API ou les charges utiles brutes.
Facturation et crédits
L'authentification elle-même ne consomme pas de crédits. Les points de terminaison multimédia authentifiés peuvent réserver ou consommer des crédits en fonction du point de terminaison. Une clé API valide ne garantit donc pas qu'une requête de génération réussira ; votre application doit gérer séparément les erreurs de solde et de quota.