Zum Inhalt springen

Eine API-Anfrage authentifizieren

Senden Sie einen Threetone-API-Schlüssel im Header x-api-key und halten Sie ihn aus Client-Code heraus.

Aktualisiert

Den API-Schlüssel als Header senden

Die öffentliche programmatische API ist unter https://api.threetone.in erreichbar. Senden Sie den Schlüssel im Anfrage-Header x-api-key:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

Verwenden Sie den Schlüssel als Headerwert, nicht in einer URL, Abfragezeichenfolge oder im Anfragekörper. Programmatische Anfragen sollen x-api-key senden. Die Kombination mit einem Authorization-Header wird als mehrdeutig zurückgewiesen.

Den Schlüssel auf dem Server verwahren

Laden Sie ihn aus einem serverseitigen Secret Manager oder einer Umgebungsvariable. Betten Sie ihn nicht in Frontend-JavaScript, Pakete mobiler Apps, Protokolle oder Fehlermeldungen ein. Verwenden Sie für jede bereitgestellte Integration einen eigenen, eng berechtigten Schlüssel, damit ein geleakter Schlüssel keine anderen Vorgänge offenlegt.

Die Anfrage-ID notieren

Threetone liefert den Antwort-Header X-Request-Id. Speichern Sie ihn zur Fehlersuche mit Zeitstempel, Methode, Pfad und Status. Sie können auch eine eigene gültige X-Request-Id senden; die API gibt sie in der Antwort zurück.