API atual/Referência completa/Conta do administrador

Minha conta

Privilégios, preferências de tela e menus escondidos do administrador autenticado.

Estas quatro rotas são o "quem sou eu" do administrador: o que ele pode fazer, como prefere ver o painel e quais menus a loja escondeu para ele. Nenhuma exige privilégio, porque cada uma só devolve (ou grava) dados do usuário do token.

GET/api/v1/admin/me/privilegesAdmin

Privilégios do próprio administrador

Devolve os nomes dos privilégios que o administrador do token possui e se ele é administrador completo. Use para esconder botões que a pessoa não poderia usar.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/me/privileges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Privilégios devolvidos

json

{
  "is_full_admin": true,
  "is_root": true,
  "privileges": [
    "view_catalog",
    "manage_catalog",
    "manage_products",
    "view_orders",
    "manage_orders",
    "manage_usergroups",
    "manage_security"
  ]
}

Campos da resposta

privilegesstring[]

Nomes dos privilégios. A lista completa de nomes possíveis está em Privilégios. Nunca é nula.

is_full_adminboolean

true quando o administrador não é restringido por grupo.

is_rootboolean

true para o dono da loja. Só um root pode promover outro administrador a root.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler os grupos ou o catálogo.	`{"error":"failed to get usergroup links","detail":"..."}`

GET/api/v1/admin/me/preferencesAdmin

Ler as preferências do administrador

Devolve um objeto JSON livre com as preferências de tela do administrador (página inicial, layout, filtros padrão). Sem preferências gravadas, a resposta é {}.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/me/preferences" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Preferências devolvidas

json

{
  "home_page": "/admin/dashboard",
  "admin_layout": "ai_native",
  "ui_preferences": {
    "default_order_status_filter": "O"
  }
}

As chaves não são um contrato fixo: o painel grava home_page, admin_layout e ui_preferences, e uma integração pode guardar as suas. Não grave segredos aqui.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler as preferências.	`{"error":"failed to get preferences","detail":"..."}`

PUT/api/v1/admin/me/preferencesAdmin

Gravar preferências do administrador

Mescla o objeto enviado nas preferências do administrador e devolve o resultado completo.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Corpo da requisição

(qualquer chave)any

O corpo é um objeto JSON de até 16 KiB. Cada chave de primeiro nível enviada substitui a chave de mesmo nome nas preferências; as que você não enviar ficam como estão. Objetos aninhados são substituídos inteiros, não mesclados.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/me/preferences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "admin_layout": "classic"
}'

Resposta

200Preferências após a mescla

json

{
  "home_page": "/admin/dashboard",
  "admin_layout": "classic",
  "ui_preferences": {
    "default_order_status_filter": "O"
  }
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
400	O corpo não é um objeto JSON (por exemplo, uma lista).	`{"error":"body must be a JSON object","detail":"..."}`
500	Falha ao gravar.	`{"error":"failed to update preferences","detail":"..."}`

GET/api/v1/admin/me/panel-menusAdmin

Menus escondidos para o administrador

Devolve as chaves de menu que a loja escondeu do painel de administrador. Quem monta uma interface própria sobre a API usa a lista para omitir as mesmas entradas. Para o dono da plataforma (root) a lista é sempre vazia.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/me/panel-menus" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Menus escondidos

json

{
  "hidden": [
    "domain:marketing",
    "item:/admin/banners"
  ]
}

Campos da resposta

hiddenstring[]

Chaves de menu escondidas. Cada chave começa com domain: (um bloco inteiro), group: (um grupo) ou item: (uma entrada). Vazia quando a loja não escondeu nada. Os exemplos acima são ilustrativos.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao carregar a configuração.	`{"error":"failed to load panel menus","detail":"..."}`

Veja também

Minha conta

Privilégios, preferências de tela e menus escondidos do administrador autenticado.

GET/api/v1/admin/me/privilegesAdmin

Privilégios do próprio administrador

Devolve os nomes dos privilégios que o administrador do token possui e se ele é administrador completo. Use para esconder botões que a pessoa não poderia usar.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/me/privileges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Privilégios devolvidos

json

{
  "is_full_admin": true,
  "is_root": true,
  "privileges": [
    "view_catalog",
    "manage_catalog",
    "manage_products",
    "view_orders",
    "manage_orders",
    "manage_usergroups",
    "manage_security"
  ]
}

Campos da resposta

privilegesstring[]

Nomes dos privilégios. A lista completa de nomes possíveis está em Privilégios. Nunca é nula.

is_full_adminboolean

true quando o administrador não é restringido por grupo.

is_rootboolean

true para o dono da loja. Só um root pode promover outro administrador a root.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler os grupos ou o catálogo.	`{"error":"failed to get usergroup links","detail":"..."}`

GET/api/v1/admin/me/preferencesAdmin

Ler as preferências do administrador

Devolve um objeto JSON livre com as preferências de tela do administrador (página inicial, layout, filtros padrão). Sem preferências gravadas, a resposta é {}.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/me/preferences" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Preferências devolvidas

json

{
  "home_page": "/admin/dashboard",
  "admin_layout": "ai_native",
  "ui_preferences": {
    "default_order_status_filter": "O"
  }
}

As chaves não são um contrato fixo: o painel grava home_page, admin_layout e ui_preferences, e uma integração pode guardar as suas. Não grave segredos aqui.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao ler as preferências.	`{"error":"failed to get preferences","detail":"..."}`

PUT/api/v1/admin/me/preferencesAdmin

Gravar preferências do administrador

Mescla o objeto enviado nas preferências do administrador e devolve o resultado completo.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Corpo da requisição

(qualquer chave)any

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/me/preferences" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "admin_layout": "classic"
}'

Resposta

200Preferências após a mescla

json

{
  "home_page": "/admin/dashboard",
  "admin_layout": "classic",
  "ui_preferences": {
    "default_order_status_filter": "O"
  }
}

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
400	O corpo não é um objeto JSON (por exemplo, uma lista).	`{"error":"body must be a JSON object","detail":"..."}`
500	Falha ao gravar.	`{"error":"failed to update preferences","detail":"..."}`

GET/api/v1/admin/me/panel-menusAdmin

Menus escondidos para o administrador

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/me/panel-menus" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Menus escondidos

json

{
  "hidden": [
    "domain:marketing",
    "item:/admin/banners"
  ]
}

Campos da resposta

hiddenstring[]

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
500	Falha ao carregar a configuração.	`{"error":"failed to load panel menus","detail":"..."}`