Authentifizierung

Die CheaperGen-API verwendet geheime API-Schlüssel. Senden Sie Ihren Schlüssel bei jeder Anfrage an einen authentifizierungspflichtigen Endpunkt als Bearer-Token im Header Authorization:

Authorization: Bearer cg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API-Schlüssel erstellen#

Öffnen Sie Dashboard → API keys und klicken Sie auf Schlüssel erstellen. Geben Sie dem Schlüssel einen Namen, der seinen Verwendungsort angibt (zum Beispiel production-backend). Schlüssel haben das Format cg_live_ gefolgt von 32 zufälligen Zeichen.

Der vollständige Schlüssel wird einmal angezeigt. Wir speichern nur einen SHA-256-Hash und können ihn nicht erneut anzeigen. Wenn Sie ihn verlieren, widerrufen Sie ihn und erstellen einen neuen. Im Dashboard stehen Präfix, Erstellungsdatum und Zeitpunkt der letzten Verwendung.

Authentifizierte Anfrage senden#

const resp = await fetch("https://cheapergen.com/api/v1/account", {
  headers: { Authorization: `Bearer ${process.env.CHEAPERGEN_API_KEY}` },
});
console.log(await resp.json());

import os, requests

resp = requests.get(
    "https://cheapergen.com/api/v1/account",
    headers={"Authorization": f"Bearer {os.environ['CHEAPERGEN_API_KEY']}"},
)
print(resp.json())

curl https://cheapergen.com/api/v1/account \
  -H "Authorization: Bearer $CHEAPERGEN_API_KEY"

Öffentliche Endpunkte#

Katalog- und Preisendpunkte benötigen keinen Schlüssel. Sie können sie im Browser oder in einem Build-Schritt aufrufen: GET /api/v1/models, GET /api/v1/models/{vendor}/{model} und POST /api/v1/quote/{endpoint}. Für alle anderen Aktionen – Generierungen absenden, abrufen oder abbrechen, Dateien hochladen und Kontoinformationen einsehen – ist ein Schlüssel nötig. Die vollständige Liste finden Sie in API-Referenz.

API-Schlüssel sicher aufbewahren#

• Nur serverseitig. Niemals einen Schlüssel in eine mobile App, ein Browser-Bundle oder ein öffentliches Repository einbauen. Jeder, der den Schlüssel hat, kann Ihr Guthaben ausgeben.
• Umgebungsvariablen verwenden oder einen Secrets-Manager einsetzen, aber keinen Quellcode. Beispiele in dieser Dokumentation lesen CHEAPERGEN_API_KEY.
• Am besten: Ein Schlüssel pro Umgebung oder Dienst; so können Sie einzelne Schlüssel widerrufen, ohne die anderen zu ändern.
• Rotieren Sie, indem Sie einen neuen Schlüssel erstellen, ihn bereitstellen und anschließend den alten widerrufen. Der Widerruf wird sofort wirksam.

Entwickeln Sie eine Client-App?#

Anfragen über Ihr eigenes Backend weiterleiten: Ihr Server verwahrt den Schlüssel, authentifiziert Ihre Nutzer und leitet Generierungsanfragen weiter. Mit Webhooks erfahren Sie, wann ein Auftrag abgeschlossen ist, und können das Ergebnis an Ihre Nutzer senden.

Authentifizierungsfehler#

Ein fehlender, fehlerhaft formatierter oder widerrufener Schlüssel gibt 401 unauthorized zurück:

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key"
  }
}

Anfragen von unserer Website (Studio und Playgrounds auf Modellseiten) werden mit Ihrer angemeldeten Sitzung statt mit einem Schlüssel authentifiziert. Im Dashboard sind sie mit der Quelle playground gekennzeichnet.