Objetivo

A API de Produção e Estoque permite que sistemas externos consultem informações operacionais do MaxManager de forma segura e padronizada.

Endpoint	Descrição
Consulta de Ordens de Produção	Acessar documentação
Consulta de Saldo de Estoque	Acessar documentação
Consulta de Formulações dos Produtos	Acessar documentação
Consulta do Extrato de Empenhos	Acessar documentação

As consultas utilizam códigos funcionais, como empresa, filial, produto e número da ordem, dispensando o conhecimento dos identificadores internos do MaxManager. A resolução desses identificadores é realizada internamente pela API.

Importante: Todos os endpoints são exclusivamente para consulta e não permitem inclusão, alteração ou exclusão de dados do ERP.

---

Endpoints disponíveis

Endpoint	Descrição
GET /v1/ordemProducao_getall	Consulta ordens de produção, composição, produções executadas, lotes e custos.
GET /v1/produto_saldoestoque_get	Consulta saldo atual do estoque, empenhos, estoque mínimo, estoque máximo e consumo médio.
GET /v1/produto_formulacao_get	Consulta formulações dos produtos e suas composições.
GET /v1/produto_empenhoextrato_get	Consulta o extrato de empenhos positivos e negativos dos produtos.

---

Requisitos

Antes de utilizar os endpoints, verifique se:

• a API do MaxManager está instalada e em execução;
• o ambiente está apontando para o banco de dados correto;
• o usuário possui credenciais válidas para autenticação;
• o usuário possui acesso à empresa e à filial consultadas;
• existem dados cadastrados para a consulta desejada.

---

Autenticação

Todos os endpoints utilizam autenticação por JWT (JSON Web Token).

Antes de consumir qualquer endpoint, realize a autenticação utilizando:

POST /v1/authorization

Para autenticar-se na API, informe um usuário e senha válidos do MaxManager.

O usuário utilizado na autenticação deve possuir permissão de acesso às empresas e filiais que serão consultadas.

Após a autenticação, o token JWT retornado deve ser informado em todas as requisições por meio do cabeçalho:

Authorization: Bearer {token}

Caso esteja utilizando o Swagger, também é possível informar o token por meio da opção Authorize.

---

Cabeçalhos da Requisição

Authorization

Cabeçalho obrigatório utilizado para autenticação da API.

Authorization: Bearer {token}

X-Correlation-ID

Cabeçalho opcional utilizado para rastreamento das requisições.

X-Correlation-ID: 85ad57ce-1748-46c3-978a-825188649355

Quando informado, esse identificador será registrado nos logs da API para facilitar a rastreabilidade das requisições.

---

Paginação

Todos os endpoints suportam paginação através dos parâmetros abaixo:

Parâmetro	Tipo	Descrição
Page	Integer	Número da página consultada.
PageSize	Integer	Quantidade de registros retornados por página.

O valor máximo permitido para PageSize é 200 registros.

---

Estrutura padrão das respostas

Todos os endpoints retornam os dados utilizando o mesmo padrão de resposta.

{
  "pageSize": 50,
  "currentPage": 1,
  "maxPageSize": 200,
  "totalPages": 1,
  "totalItens": 1,
  "data": []
}

Campos da resposta

Campo	Descrição
pageSize	Quantidade de registros retornados na página.
currentPage	Página retornada pela consulta.
maxPageSize	Quantidade máxima permitida por página.
totalPages	Total de páginas disponíveis para a consulta.
totalItens	Quantidade total de registros encontrados.
data	Lista contendo os registros retornados pelo endpoint.

Quando nenhum registro for encontrado, a API retornará HTTP 200 (OK) com totalItens igual a zero e a coleção data vazia.

---

Formato dos Dados

As requisições e respostas utilizam o formato JSON.

As datas devem ser informadas no padrão:

AAAA-MM-DD

Os parâmetros booleanos aceitam os valores:

true
false

Campos sem valor poderão ser retornados como null, e listas sem registros serão retornadas vazias.

---

Segurança

A API realiza automaticamente as seguintes validações:

• autenticação do usuário;
• permissão de acesso à empresa e filial;
• validação dos filtros obrigatórios;
• validação dos parâmetros informados na requisição.

As permissões são aplicadas conforme o usuário autenticado, garantindo que apenas empresas e filiais autorizadas possam ser consultadas.

---

Códigos de Resposta

Código	Descrição
200 (OK)	Requisição processada com sucesso, com ou sem registros.
400 (Bad Request)	Parâmetros inválidos ou ausência de informações obrigatórias.
401 (Unauthorized)	Token de autenticação não informado, inválido ou expirado.
403 (Forbidden)	Usuário sem permissão para acessar os dados solicitados.
500 (Internal Server Error)	Erro interno durante o processamento da requisição.

Os códigos e mensagens podem variar conforme a configuração da API e a versão utilizada no ambiente.

---