API Rest

A API REST é a ferramenta ideal para integrar o ERP Maxiprod com outros sistemas. Funciona como uma ponte entre o ERP MAXIPROD e aplicações externas, permitindo consultar dados em tempo real e realizar operações com segurança.

Esta página mostra:

• Conceitos básicos
• Autenticação e segurança
• Estrutura das requisições
• Cabeçalhos obrigatórios
• Paginação e filtros
• Recursos disponíveis (endpoints)
• Como gerar token a partir de e-mail e senha?

Conceitos básicos

• A API segue o padrão REST e utiliza o formato JSON para envio e recebimento de dados.
• Todas as URLs começam com https://api.maxiprod.com.br/api/.
• Os campos seguem a nomenclatura padronizada do ERP.
• As datas são retornadas no formato YYYY-MM-DD.

Autenticação e segurança

• O acesso é realizado via token de autenticação.
• Cada usuário ou integração possui seu próprio token.
• Todas as requisições devem ser feitas via HTTPS.
• Inclua o token no cabeçalho (header) da requisição:

Authorization: Bearer {seu_token}

Estrutura das requisições

Métodos suportados:

• GET: consultar dados
• POST: criar registros
• PUT: atualização total dos registros
• PATCH: atualização parcial dos registros
• DELETE: excluir registros

Importante: os métodos disponíveis para cada endpoint podem ser consultados acessando a documentação Swagger.

Cabeçalhos obrigatórios

Content-Type: application/json
Authorization: Bearer {seu_token}

Paginação e filtros

Utilize parâmetros de query, por exemplo:

• https://api.maxiprod.com.br/api/PedidoDeVenda?data=2025-09-01&estado=aprovado

Recursos disponíveis (endpoints)

Para conhecer os endpoints disponíveis, exemplos de esquemas, métodos aceitos e as respostas possíveis, acesse o link Documentação Swagger.

Como gerar token a partir de e-mail e senha?

1) Através da plataforma API que estiver utilizando. No exemplo, utilizaremos o Postman. Faça uma requisição POST com o e-mail e senha do usuário que deseja gerar a autenticação.

• URL de requisição: https://api.maxiprod.com.br/api/login
• Requisição cURL:

curl --location 'https://api.maxiprod.com.br/api/Login' \
--header 'Content-Type: application/json' \
--data-raw '{ 
"email": "informar-email", 
"senha": "informar-senha" 
}'

2) Copie a cURL acima, substitua o campo "informar_email" pelo e-mail do usuário, e o campo "informar_senha" pela senha que o usuário utiliza para acessar o ERP. A seguir, cole no Postman.

Dica: para importar a cURL no Postman, clique na opção “Importar” (ou “Import” no menu superior esquerdo). Para colar o texto bruto (ou “Raw Text”), cole o comando cURL na área indicada e clique em “Importar”.

3) Ao clicar em “Send”, a requisição será enviada e a resposta informará o token de acesso:

curl --location 'https://api.maxiprod.com.br/api/Login' \
--header 'accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'DeleteAnterior: true' \ --aqui pode ser true, caso decida derrubar a sessão, ou false, caso deseje manter a sessão anterior.
--header 'DeleteAnteriorToken: {hash_da_requisição_428}' \
--data-raw '{
"email": "seu_email",
"senha": "sua_senha"
}'