VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Registro de atividades

Configurar o que é registrado

Liga e desliga o registro de cada par tipo e ação, e semeia a lista padrão de pares.

Nem tudo precisa ser registrado. Cada par type + action (por exemplo orders + update) tem uma chave enabled. Um evento só entra no registro se o par existir e estiver ligado. As rotas desta página exigem o privilégio manage_log_settings.

Ler configuração

GET/api/v1/admin/logs/settingsAdmin

Lista os pares tipo/ação e se estão ligados

Exemplo de requisição

Resposta

200Configuração

Campos da resposta

settingsarray
Ordenado por type e action.
settings[].typestring
Família do evento.
settings[].actionstring
Ação.
settings[].enabledboolean
true grava o evento; false o descarta.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_log_settings"]}
500Falha ao consultar.{"error":"failed to get log settings","detail":"..."}

Alterar configuração

PUT/api/v1/admin/logs/settingsAdmin

Liga ou desliga pares tipo/ação

Corpo da requisição

settingsarrayobrigatório

Lista de pares a gravar. Pares não citados ficam como estão.

typestringobrigatório
Família do evento.
actionstringobrigatório
Ação.
enabledbooleanobrigatório
Ligado ou desligado.

Exemplo de requisição

Resposta

200Configuração salva

Campos da resposta

messagestring
Sempre log settings updated.
settingsarray
A configuração completa depois da alteração (mesmo formato de Ler configuração).

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_log_settings"]}
400Corpo não é JSON válido.{"error":"invalid request body","detail":"..."}
500Falha ao gravar.{"error":"failed to update log settings","detail":"..."}
A própria mudança é auditada

Alterar a configuração gera um registro logs + settings_update. Desligar esse par apaga o rastro das próximas mudanças, então mantenha-o ligado.

Pares desconhecidos são aceitos

A rota cria o par se ele não existir e não valida se type e action são conhecidos. Um par com grafia errada fica gravado e nunca será usado.

Semear pares padrão

POST/api/v1/admin/logs/seed-settingsAdmin

Cria os pares padrão que faltam

Exemplo de requisição

Resposta

200Pares criados

Campos da resposta

messagestring
Sempre default log settings seeded.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_log_settings"]}
500Falha ao gravar.{"error":"failed to seed log settings","detail":"..."}
Idempotente

Só insere o que falta (como ligado); nunca altera um par existente. Chame depois que a plataforma passar a registrar novos tipos de evento: sem o par, o evento é descartado em silêncio.

Veja também

  • Consultar registros
  • Limpar registros antigos
Anterior
Consultar registros
Próxima
Limpar registros antigos
Nesta página
  • Ler configuração
  • Exemplo de requisição
  • Resposta
  • Erros
  • Alterar configuração
  • Exemplo de requisição
  • Resposta
  • Erros
  • Semear pares padrão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl "$BASE_URL/api/v1/admin/logs/settings" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X PUT "$BASE_URL/api/v1/admin/logs/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"settings": [{"type": "orders", "action": "update", "enabled": true}]}'
bash
curl -X POST "$BASE_URL/api/v1/admin/logs/seed-settings" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "settings": [
    {
      "type": "auth",
      "action": "login",
      "enabled": true
    },
    {
      "type": "orders",
      "action": "update",
      "enabled": true
    }
  ]
}
json
{
  "message": "log settings updated",
  "settings": [
    {
      "type": "orders",
      "action": "update",
      "enabled": true
    }
  ]
}
json
{
  "message": "default log settings seeded"
}