API de marcas

No ANKK, cada chave da API pública é vinculada automaticamente a uma única marca durante a criação. Todas as requisições posteriores operam no contexto dessa marca. Consulte os detalhes da marca para verificar a validade da chave e o status do acesso.

📌 Endpoints

Método	Caminho	Descrição	Escopo Necessário
`GET`	`/v1/brand`	Recupera detalhes da marca vinculada à chave de API	`brands:read` ou `*`
`GET`	`/v1/brands`	Recupera, em uma lista, a marca vinculada à chave	`brands:read` ou `*`

🔍 Obter Detalhes da Marca (`GET /v1/brand`)

Verifique a qual marca sua chave de API spk_... está anexada.

Exemplo de Requisição

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

Exemplo de Resposta (`200 OK`)

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

Campos da Resposta

Campo	Tipo	Descrição
`brand_ref`	`string`	Identificador exclusivo da marca (formato ULID)
`name`	`string`	Nome de exibição da marca
`slug`	`string`	Slug exclusivo usado em caminhos de URL
`role`	`string`	Função de permissão do emissor da chave (`owner`)
`is_locked`	`boolean`	Indica se a marca está bloqueada devido a restrições de faturamento ou política

[!IMPORTANT] Se is_locked: true, as operações de publicação e escrita serão bloqueadas com 423 Locked (brand_locked). Verifique sua assinatura em Planos e Limites ou no Guia de Faturamento.

🔗 Documentação Relacionada