API des marques

Dans ANKK, chaque clé API publique est automatiquement liée à une seule marque lors de sa création. Toutes les requêtes suivantes s’exécutent dans le contexte de cette marque. Consultez les détails de la marque pour vérifier la validité de la clé et l’état de l’accès.

📌 Points de terminaison (Endpoints)

Méthode	Chemin	Description	Portée (Scope) requise
`GET`	`/v1/brand`	Récupérer les détails de la marque liée à la clé API	`brands:read` ou `*`
`GET`	`/v1/brands`	Récupérer la marque liée à la clé, enveloppée dans un tableau de liste	`brands:read` ou `*`

🔍 Obtenir les détails de la marque (`GET /v1/brand`)

Vérifiez à quelle marque votre clé API spk_... est attachée.

Exemple de requête

curl -X GET "https://api.ankk.app/v1/brand" \
  -H "Authorization: Bearer spk_live_xxxxxxxx"

Exemple de réponse (`200 OK`)

{
  "brand_ref": "brand_01jm8v4k9example",
  "name": "ACME Studio",
  "slug": "acme-studio",
  "role": "owner",
  "is_locked": false
}

Champs de réponse

Champ	Type	Description
`brand_ref`	`string`	Identifiant unique de la marque (format ULID)
`name`	`string`	Nom d’affichage de la marque
`slug`	`string`	Slug unique utilisé dans les chemins d’URL
`role`	`string`	Rôle de permission de l’émetteur de la clé (`owner`)
`is_locked`	`boolean`	Indique si la marque est verrouillée en raison de restrictions de facturation ou de politique

[!IMPORTANT] Si is_locked: true, les opérations de publication et d’écriture seront bloquées avec l’erreur 423 Locked (brand_locked). Vérifiez votre abonnement dans Forfaits et limites ou le Guide de facturation.

🔗 Documentation connexe