Authentifizierung
Authentifizieren Sie Kitta Audio Open API-Anfragen.
Authentifizierung
Kitta Audio Open API-Anfragen verwenden Inhaberschlüssel API. Der Schlüssel API identifiziert das Konto, den Berechtigungsbereich, das Kontingent und den Abrechnungskontext für die Anfrage.
Authorization: Bearer KITTA_API_KEYErstellen und verwalten Sie API-Schlüssel in Ihrem Konto:
https://kittaai.com/en/account?section=apiRegeln anfordern
Jede Open API-Anfrage muss den Authorization-Header enthalten. JSON-Anfragen sollten auch Content-Type: application/json enthalten. Bei mehrteiligen Endpunkten sollte Ihr HTTP-Client die mehrteilige Grenze festlegen können.
curl https://kittaai.com/api/open/v1/profile \
-H "Authorization: Bearer KITTA_API_KEY"Senden Sie keine API-Schlüssel vom Browser JavaScript, mobilen Apps, öffentlichen Repos, Protokollen, Analyseereignissen oder für den Kunden sichtbaren Fehlermeldungen. Behandeln Sie den API-Schlüssel wie ein Passwort für Ihr Produktionskonto.
API Schlüsselspeicher
Speichern Sie den API-Schlüssel in einem serverseitigen Secret Manager oder einer verschlüsselten Umgebungsvariablen. Laden Sie es beim Prozessstart und übergeben Sie es nur an den HTTP-Client, der mit Kitta Audio kommuniziert. Wenn Sie Hintergrund-Worker ausführen, geben Sie den Workern dasselbe Geheimnis über Ihre Bereitstellungsplattform weiter, anstatt es in Job-Payloads zu kopieren.
Rotieren Sie API-Schlüssel, wenn ein Teammitglied das Team verlässt, wenn ein Build-Protokoll möglicherweise ein Geheimnis preisgegeben hat oder wenn Sie eine Integration vom Staging in die Produktion verschieben. Stellen Sie nach der Rotation zuerst den neuen Schlüssel API bereit, überprüfen Sie den Datenverkehr und widerrufen Sie dann den alten Schlüssel API.
Antwort und Fehlerbehandlung
Authentifizierungsfehler geben JSON-Fehler zurück, wenn die Anforderung die API-Schicht erreicht.
| Status | Bedeutung | Aktion |
|---|---|---|
401 | Der API-Schlüssel fehlt, ist fehlerhaft, wurde widerrufen oder gehört zu einem deaktivierten Konto | Stoppen Sie Wiederholungsversuche und aktualisieren Sie den konfigurierten API-Schlüssel |
402 | Credits oder API-Kontingent reichen nicht aus | Fordern Sie den Kontoinhaber auf, die Batch-Größe aufzuladen oder zu reduzieren |
429 | Die Anfrage ist preisbegrenzt | Wiederholen Sie den Vorgang mit Backoff und behalten Sie nach Möglichkeit die ursprüngliche Job-ID bei |
Protokollieren Sie requestId aus Fehlerantworten. Dadurch kann der Support die genaue Anfrage lokalisieren, ohne Sie aufzufordern, API-Schlüssel oder Rohnutzdaten weiterzugeben.
Abrechnung und Gutschriften
Für die Authentifizierung selbst werden keine Credits verbraucht. Authentifizierte Medienendpunkte können je nach Endpunkt Credits reservieren oder verbrauchen. Ein gültiger API-Schlüssel garantiert daher nicht, dass eine Generierungsanforderung erfolgreich ist. Ihre Anwendung sollte Saldo- und Kontingentfehler separat behandeln.