Clés d'API
Créer une clé, choisir ses portées, la garder au chaud.
Une clé d'API remplace votre mot de passe pour les programmes. Elle s'utilise dans l'en-tête Authorization, et se révoque à tout moment sans toucher au reste du compte.
Créer une clé#
Donner un nom explicite
« CI GitHub », « script de supervision », « mon-app-mobile ». Quand vous en aurez six, c'est ce nom qui vous dira laquelle révoquer sans tout casser.
Choisir la portée
Lecture seule pour consulter, lecture et écriture pour agir. Ne prenez la seconde que si le programme doit réellement modifier quelque chose : démarrer un conteneur, créer un domaine, publier un site.
C'est le réglage qui explique le plus de refus en 403. Le message est explicite (« cette clé d'API est en lecture seule »), mais la portée ne se change pas après coup — il faut créer une autre clé. Typiquement, npx ecloudserv-pages deploy exige l'écriture, alors que list et whoami se contentent de la lecture.
Copier la clé immédiatement
Elle ne s'affiche qu'une fois, à la création. Si vous la perdez, il faut en générer une nouvelle — c'est plus sûr que de pouvoir la relire indéfiniment.
L'utiliser#
curl https://api.ecloudserv.fr/api/v1/me \
-H "Authorization: Bearer VOTRE_CLE"Une réponse 200 avec les informations de votre compte confirme que la clé est valide. Un 401 signifie qu'elle est absente, mal formée ou révoquée.
Depuis votre code#
La clé se lit dans une variable d'environnement — jamais écrite dans le fichier :
const res = await fetch("https://api.ecloudserv.fr/api/v1/servers", {
headers: { Authorization: `Bearer ${process.env.ECLOUD_API_KEY}` },
});
if (!res.ok) throw new Error(`API : HTTP ${res.status}`);
const servers = await res.json();Bonnes pratiques#
- Une clé par usage. Si celle de la CI fuite, vous la révoquez sans couper vos autres scripts.
- La portée minimale. Un script qui lit n'a pas besoin de
write. - Jamais dans le dépôt. Utilisez les secrets de votre CI, ou une variable d'environnement — voir Variables & secrets.
- Révoquez au moindre doute. Créer une nouvelle clé prend dix secondes ; nettoyer après un incident prend bien plus longtemps.
Une clé dans une capture d'écran est une clé fuitée