Pular para conteúdo

APIs

Escopo e autenticação

AssetGuard é a API do CoreFlow Assets, não um serviço separado. A versão /api/v1/ é somente leitura: os ViewSets herdam de ReadOnlyModelViewSet. Login de token: POST /api/v1/auth/token/, com usuário e senha; enviar o token em Authorization: Token <chave>. Session Authentication também está habilitada.

Cada leitura exige permissão Django view_<model> por meio de apps.core.api_permissions.ModelPermissions. Os grupos Leitura, Operador e Administrador reutilizam as permissões das telas. Usuário sem autenticação recebe 401; usuário autenticado sem permissão recebe 403. Métodos de escrita não são publicados na v1.

Recursos

Recurso Rota base Filtros específicos Busca
Categorias /api/v1/categorias-ativo/ — nome
Ativos /api/v1/ativos/ status, categoria, setor, unidade código patrimonial, descrição, série, marca, modelo
Unidades /api/v1/unidades/ — nome, endereço
Setores /api/v1/setores/ unidade setor e nome da unidade
Movimentações /api/v1/movimentacoes/ ativo (UUID), tipo código patrimonial, motivo
Rodadas /api/v1/rodadas-inventario/ status descrição
Divergência /api/v1/rodadas-inventario/<uuid>/divergencia/ — relatório consolidado da rodada
Itens de inventário /api/v1/itens-inventario/ rodada (UUID), encontrado (true/false) código patrimonial

Os ViewSets usam ordering nos campos declarados no código e paginação por número de página, 20 registros por página (?page=N). Filtros numéricos inválidos são ignorados; UUID inválido resulta em conjunto vazio.

Respostas e documentação

  • Schema OpenAPI: /api/schema/.
  • Swagger UI: /api/docs/.
  • Redoc: /api/redoc/.
  • As respostas usam JSON e navegação de detalhe pelo identificador do recurso.
  • O serializer de ativos inclui código, dados de aquisição, status, Centro de Custo, URLs de foto/QR, localização e responsável atuais.

Fronteiras da v1

Cadastro/edição de ativo, movimentação, bipagem e fechamento de inventário continuam nas telas internas e nos serviços do domínio. POST, PUT, PATCH e DELETE não são operações da API pública atual.

Referências

  • ViewSets/serializers: apps/ativos/api/, apps/localizacao/api/ e apps/inventario/api/.
  • Permissões: apps/core/api_permissions.py e migrations *_seed_permissoes.py.
  • Referência operacional: documentacao/API Referencia - AssetGuard v1.md no repositório-fonte.