Aller au contenu

Authentification et scopes

Clés bk_live_*, cycle de vie des clés et matrice des scopes requis par opération.

2 min de lecture 3 sections

Chaque requête est effectuée avec l’en-tête Authorization: Bearer bk_live_…. L’API Developer n’accepte que les clés live ; il n’existe ni clé sandbox ni chemin de données de test distinct.

http
Authorization: Bearer bk_live_…

Propriété#

La passerelle fait vérifier la clé par le service Auth et ne transmet à l’API Link que le propriétaire vérifié de la clé. Un ownerId, un userId ou des valeurs de scope supplémentaires dans le corps ou la query de la requête ne peuvent pas modifier la propriété ; chaque requête et chaque mutation est limitée aux ressources du propriétaire de la clé.

Matrice des scopes#

OpérationScope requis
Lecture des liens, trees, boards, dossiers et routes ; lecture du QR ; catalogue des plateformeslinks:read
Création/mise à jour, modification des conditions/cibles/propriétés d’une route, écriture du QRlinks:write
Suppression des liens, trees, boards, dossiers et sous-ressources de routelinks:delete
GET /api/v1/links/:id/analyticsanalytics:read
Lecture des métadonnées de domainedomains:read

Si un scope est manquant, la réponse est 403. Les chemins publics non définis sont refusés par défaut (deny-by-default).

Cycle de vie des clés#

MéthodeCheminDescription
GET/v1/developer/api-keysListe des métadonnées de vos clés (sans secret).
POST/v1/developer/api-keysNouvelle clé avec name, scopes et un expiresAt facultatif.
POST/v1/developer/api-keys/:id/rotateInvalide l’ancienne clé et génère un nouveau secret avec les mêmes scopes/la même durée.
DELETE/v1/developer/api-keys/:idRévoque la clé.

Ces endpoints sont protégés par session ; la console développeur effectue les mêmes opérations depuis l’interface. Vous pouvez avoir plusieurs clés actives ; sans expiresAt, la clé n’expire jamais.

N’écrivez pas le secret dans le stockage du navigateur, les logs ou les URL. Auprès de l’assistance, communiquez le X-Request-Id de la réponse plutôt que la clé.

Il manque quelque chose ou il y a une erreur ? Écrivez à l’équipe d’assistance, en joignant la valeur X-Request-Id de la réponse, vous accélérerez la résolution.