Clés d’API

Une clé ouvre l’API pour une organisation, dans un mode. Elle se gère dans Développeurs › Clés : aucune route de /v1 ne crée de clé. Seuls le propriétaire et l’administrateur d’une organisation le font.

Genres

Préfixe	Genre	Droits
`sk_test_`	Secrète, mode test	Toutes les routes, sur les objets de test
`sk_live_`	Secrète, production	Toutes les routes, sur les objets de production
`rk_test_`	Restreinte, mode test	Les droits qu’elle porte
`rk_live_`	Restreinte, production	Les droits qu’elle porte

La clé décide du mode : un objet de test n’existe pas pour une clé de production, et l’inverse.

Cycle de vie

Création : le secret s’affiche une fois, puis seule son empreinte reste. Votre adresse doit être confirmée.
Usage : la clé répond à chaque appel, et last_used_at date son dernier usage.
Rotation : la remplaçante marche aussitôt, et l’ancienne encore 24 heures. Le recouvrement se règle de 0 à 168 heures.
Révocation : la clé cesse à la requête suivante.

Je veux…

Je veux…	Où
Créer une clé	Développeurs › Clés › Créer une clé
Limiter une clé à la lecture des factures	Clé restreinte, droit `claims:read`
Changer une clé sans coupure	Faire tourner, puis déployer la nouvelle pendant le recouvrement
Couper une clé tout de suite	Révoquer
Voir ce qu’une clé a appelé	`GET /v1/requests?key=key_…`

Droits d’une clé restreinte

Droit	Ouvre
`events:read`	Événements
`requests:read`	Requêtes
`webhooks:read`, `webhooks:write`	Points de terminaison
`practitioners:read`, `practitioners:write`	Praticiens
`patients:read`, `patients:write`	Patients et droits
`claims:read`, `claims:write`	Factures et prestations
`workstations:read`, `workstations:write`	Postes et codes d’appairage

Chaque page de la référence dit le droit que sa route demande.

Événements

Une clé n’émet aucun événement.

Pièges

Une écriture n’implique pas la lecture. claims:write seul ne lit pas une facture : insufficient_scope.
Le secret ne se retrouve pas. Perdu, il se remplace par une rotation.
Une clé reste côté serveur. Jamais dans une application mobile ni dans un navigateur.
Après une rotation, l’ancienne clé expire. Elle répond alors api_key_expired, pas invalid_api_key.