Authentification

L’API CheaperGen utilise des clés API secrètes. Pour chaque requête adressée à un point de terminaison avec authentification, envoyez votre clé comme jeton Bearer dans l’en-tête Authorization :

Authorization: Bearer cg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Créer une clé#

Ouvrez Tableau de bord → Clés API, puis cliquez sur Créer une clé. Choisissez un nom qui précise l’usage de la clé (par exemple production-backend). Les clés commencent par cg_live_, suivi de 32 caractères aléatoires.

La clé complète ne s’affiche que une seule fois. Nous n’en conservons qu’une empreinte SHA-256 : il est donc impossible de l’afficher à nouveau. Si vous la perdez, révoquez-la et créez-en une nouvelle. Le tableau de bord répertorie chaque clé avec son préfixe, sa date de création et sa dernière date d’utilisation.

Effectuer une requête authentifiée#

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"

Points de terminaison publics#

Les points de terminaison du catalogue et des tarifs ne nécessitent pas de clé : vous pouvez les appeler depuis un navigateur ou une étape de compilation : GET /api/v1/models, GET /api/v1/models/{vendor}/{model} et POST /api/v1/quote/{endpoint}. Tous les autres — envoi, consultation et annulation des générations, importation et compte — nécessitent une clé. Consultez Référence de l’API pour la liste complète.

Protéger les clés#

• Côté serveur uniquement. N’intégrez jamais une clé à une application mobile, à un bundle de navigateur ou à un dépôt public. Toute personne qui la possède peut dépenser votre solde.
• Utilisez des variables d’environnement ou passez par un gestionnaire de secrets ; ne stockez jamais la clé dans le code source. Dans ces exemples, les instructions lisent CHEAPERGEN_API_KEY.
• Une clé par environnement ou service, afin de pouvoir en révoquer une sans toucher aux autres.
• Cliquez sur « Renouveler » : créez une nouvelle clé, déployez-la, puis révoquez l’ancienne. La révocation prend effet immédiatement.

Vous développez une application côté client ?#

Faites transiter les requêtes par votre propre backend : votre serveur conserve la clé, authentifie vos utilisateurs et relaie leurs requêtes de génération. Utilisez webhooks pour savoir quand une tâche est terminée et transmettre le résultat à vos utilisateurs.

Erreurs d’authentification#

Une clé manquante, mal formée ou révoquée renvoie 401 unauthorized :

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

Les requêtes envoyées depuis notre site (Studio et pages de modèles) sont authentifiées par votre session ouverte plutôt que par une clé ; elles apparaissent dans le tableau de bord avec la source playground.