Skip to content

Clés API

Maintenu par : Aether365 Team Public : Développeurs Périmètre : Endpoints de gestion des clés API

Les clés API servent à authentifier les requêtes vers l'API REST sans session utilisateur.

Chaque clé API est liée au compte tenant qui l'a créée. Les clés API ont le même niveau d'accès qu'un membre de l'équipe : elles peuvent lire et écrire toutes les données du tenant, mais ne peuvent pas modifier la facturation ni les paramètres de plan.

Lister les clés API

Renvoie toutes les clés API actives du tenant.

GET /tenants/me/api-keys

INFO

Pour des raisons de sécurité, la valeur complète de la clé n'est renvoyée qu'une seule fois, lors de la création. Les requêtes de liste ultérieures n'affichent que le préfixe de la clé et ses métadonnées.

Exemple de requête

bash
curl https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>"

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI pipeline",
      "prefix": "ae_live_abc1",
      "createdAt": "2026-03-01T09:00:00Z",
      "lastUsedAt": "2026-04-10T14:23:00Z"
    }
  ]
}

Champs de la réponse

ChampTypeDescription
idstringIdentifiant de la clé
namestringNom d'affichage
prefixstring12 premiers caractères de la clé (pour identification)
createdAtstringHorodatage ISO 8601
lastUsedAtstring ou nullHorodatage ISO 8601 de la dernière requête authentifiée

Créer une clé API

Crée une nouvelle clé API. La valeur complète de la clé est renvoyée une seule fois et ne peut pas être récupérée ultérieurement.

POST /tenants/me/api-keys

Corps de la requête

json
{
  "name": "CI pipeline"
}
ChampTypeRequisDescription
namestringOuiNom d'affichage de la clé

Exemple de requête

bash
curl -X POST https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Exemple de réponse

json
{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI pipeline",
    "key": "ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "prefix": "ae_live_abc1",
    "createdAt": "2026-04-12T10:00:00Z",
    "lastUsedAt": null
  }
}

Stockez la clé immédiatement

Le champ key n'est renvoyé que dans cette réponse. Il ne peut pas être récupéré ultérieurement. Stockez-le dans un gestionnaire de secrets (GitHub Actions secrets, HashiCorp Vault, etc.) immédiatement.


Supprimer une clé API

Révoque définitivement une clé API. Toute requête utilisant cette clé renverra immédiatement 401.

DELETE /tenants/me/api-keys/{keyId}

Exemple de requête

bash
curl -X DELETE https://api.aether365.io/tenants/me/api-keys/key_abc123 \
  -H "Authorization: Bearer <token>"

Exemple de réponse

json
{
  "success": true,
  "data": null
}

Utiliser une clé API

Transmettez la clé API en tant que jeton Bearer dans l'en-tête Authorization :

bash
curl https://api.aether365.io/tenants/me/scans \
  -H "Authorization: Bearer ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Les clés API fonctionnent de la même manière que les jetons de session pour tous les endpoints. Elles n'expirent pas, mais vous pouvez les faire tourner en créant une nouvelle clé et en supprimant l'ancienne.

Limites de débit

L'API est limitée à 120 requêtes par minute par clé API. Les requêtes dépassant la limite de débit reçoivent une réponse 429 Too Many Requests. La réponse inclut un en-tête Retry-After indiquant quand vous pouvez réessayer.

Cette page vous a-t-elle été utile ?