Docs/Clés API

Clés API

Gérez des clés API propres à une équipe, par programmation ou depuis le tableau de bord. Les clés s'authentifient via l'en-tête Authorization: Bearer.

Créer une clé

POST/keys

Génère une nouvelle clé pour une équipe et un environnement. La réponse inclut le secret en clair — enregistrez-le immédiatement, car il ne pourra plus être récupéré.

Champ	Description
`teamId`	L'UUID de l'équipe à laquelle appartient cette clé.
`name`	Un libellé lisible pour la clé, affiché dans le tableau de bord.
`env`	L'environnement auquel la clé est limitée : `live` ou `test`.
`expiresAt`	Facultatif. Date-heure ISO 8601 après laquelle la clé cesse de fonctionner. Omettez ce champ pour une clé qui n'expire jamais.

curl -X POST https://api.seeitlive.io/v1/keys \
  -H "Authorization: Bearer <dashboard-jwt>" \
  -H "Content-Type: application/json" \
  -d '{ "teamId": "<uuid>", "name": "Server key", "env": "live" }'

json

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "Server key",
  "env": "live",
  "prefix": "sil_live_ab12cd",
  "secret": "sil_live_ab12cdxxxxxxxxxxxxxxxxxxxxxxxx"
}

Affiché une seule fois

Le champ secret n'est renvoyé qu'à la création, jamais ensuite.

Créer et révoquer des clés nécessite la permission manage_keys sur l'équipe ; lister les clés ne nécessite que view_team.

Lister les clés

GET/keys?teamId=<uuid>

Renvoie les clés actives (non révoquées) d'une équipe. Le secret n'est jamais inclus — seul le préfixe l'est, suffisant pour identifier une clé dans le tableau de bord ou les journaux.

json

[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Server key",
    "env": "live",
    "prefix": "sil_live_ab12cd",
    "lastUsedAt": "2026-07-01T12:03:44.000Z",
    "createdAt": "2026-06-15T09:12:00.000Z"
  }
]

Mettre à jour une clé

PATCH/keys/:id

Met à jour partiellement une clé. Seuls les champs fournis sont modifiés ; les champs omis restent inchangés.

Champ	Description
`name`	Un nouveau libellé pour la clé.
`allowedIps`	La liste unifiée des sources autorisées : IP, plages CIDR ou noms d'hôte, un par élément du tableau. Remplace la liste existante.
`expiresAt`	Date-heure ISO 8601, ou `null` pour supprimer une expiration existante.

curl -X PATCH https://api.seeitlive.io/v1/keys/d290f1ee-6c54-4b01-90e6-d701748f0851 \
  -H "Authorization: Bearer <dashboard-jwt>" \
  -H "Content-Type: application/json" \
  -d '{ "allowedIps": ["10.0.0.0/8 # office VPN"], "expiresAt": "2026-12-31T00:00:00.000Z" }'

json

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "Server key",
  "env": "live",
  "prefix": "sil_live_ab12cd",
  "allowedIps": ["10.0.0.0/8 # office VPN"],
  "expiresAt": "2026-12-31T00:00:00.000Z",
  "lastUsedAt": "2026-07-01T12:03:44.000Z",
  "createdAt": "2026-06-15T09:12:00.000Z"
}

Révoquer une clé

DELETE/keys/:id

Désactive immédiatement une clé. Les requêtes en cours qui l'utilisent commencent aussitôt à échouer, et elle n'apparaît plus dans la réponse de liste.

json

{ "ok": true }

Signature des requêtes

La signature ajoute une vérification HMAC en plus de la clé porteuse. Consultez le contrat de signature dans le guide d'authentification pour savoir précisément comment calculer et envoyer la signature.

Activer la signature

POST/keys/:id/signing/enable

Active la signature pour une clé et renvoie le secret de signature. Le secret n'est affiché qu'une seule fois — enregistrez-le immédiatement.

json

{ "signingSecret": "3fa1e2d0c9b84a5b8c9d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f7081920a3b4c5" }

Faire tourner le secret de signature

POST/keys/:id/signing/rotate

Émet un nouveau secret de signature pour une clé, invalidant le précédent. Également affiché une seule fois.

json

{ "signingSecret": "8c9d0e1f2a3b4c5d6e7f8091a2b3c4d53fa1e2d0c9b84a5b6e7f8091920a3b4c" }

Désactiver la signature

POST/keys/:id/signing/disable

Désactive la signature pour une clé. Les requêtes qui lui sont adressées n'ont plus besoin de signature.

json

{ "ok": true }

Authentification Sessions