Clés API

Gérez vos clés API depuis le dashboard. Ces endpoints s'authentifient avec votre session de connexion au dashboard (un jeton d'accès JWT), pas avec une clé bearer pm_, ce qui les distingue des endpoints de vérification décrits dans Authentification.

Créer une clé

POST /api/keys génère une nouvelle clé et renvoie le secret brut une seule fois, dans le champ raw_key. Seul son hash est stocké, donc sauvegardez-le immédiatement.

curl -X POST https://api.pricklymails.com/api/keys \
  -H "Authorization: Bearer votre_jeton_jwt" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Serveur de production", "environment": "live" }'

Passez éventuellement scopes et enabled_checks pour restreindre ce que la clé peut faire ; les deux prennent les valeurs par défaut du projet en leur absence. La limite de débit n'est pas acceptée ici : elle est ensemencée depuis votre plan et ne peut pas être auto-attribuée.

Lister et récupérer

GET /api/keys liste toutes les clés que vous possédez, les plus récentes en premier. GET /api/keys/{uuid} en récupère une, limitée à votre compte.

Modifier une clé

PATCH /api/keys/{uuid} met à jour le name affiché ou les enabled_checks. Les champs non fournis conservent leur valeur actuelle. Un contrôle demandé que votre plan n'autorise pas renvoie 403. La limite de débit n'est jamais modifiable via cet endpoint : elle dépend du plan et se réaligne automatiquement à chaque changement de plan.

Révoquer une clé

DELETE /api/keys/{uuid} révoque la clé. C'est idempotent : révoquer une clé déjà révoquée renvoie la même ligne avec son horodatage revoked_at existant.

Introspecter la clé courante

GET /api/keys/me diffère du reste de cette page : il s'authentifie avec la clé bearer pm_ elle-même, pas avec un JWT, pour qu'une intégration puisse confirmer qu'une clé fraîchement créée fonctionne, et lire son nom, son environnement, ses portées et ses contrôles activés, avant de lancer une vérification facturable.

Live et test

L'environnement d'une clé (live ou test) est choisi à la création et est comportemental, pas qu'une étiquette : une clé pm_test_ exécute le bac à sable décrit dans Authentification et ne débite jamais votre portefeuille.