API de marcas

En ANKK, cada clave de API pública se vincula automáticamente a una sola marca al crearla. Todas las solicitudes posteriores operan en el contexto de esa marca. Puede consultar los detalles de la marca para verificar la validez de la clave y el estado del acceso.

📌 Puntos finales

Método	Ruta	Descripción	Alcance requerido
`GET`	`/v1/brand`	Recuperar detalles de la marca vinculada a la clave de API	`brands:read` o `*`
`GET`	`/v1/brands`	Recuperar, en una lista, la marca vinculada a la clave	`brands:read` o `*`

🔍 Obtener detalles de la marca (`GET /v1/brand`)

Verifique a qué marca está asociada su clave de API spk_....

Ejemplo de solicitud

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

Ejemplo de respuesta (`200 OK`)

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

Campos de respuesta

Campo	Tipo	Descripción
`brand_ref`	`string`	Identificador único de marca (formato ULID)
`name`	`string`	Nombre visible de la marca
`slug`	`string`	Slug único utilizado en las rutas de URL
`role`	`string`	Rol de permiso del emisor de la clave (`owner`)
`is_locked`	`boolean`	Indica si la marca está bloqueada debido a restricciones de facturación o políticas

[!IMPORTANT] Si is_locked: true, las operaciones de publicación y escritura se bloquearán con 423 Locked (brand_locked). Consulte su suscripción en Planes y límites o en la Guía de facturación.

🔗 Documentación relacionada