O ERP MAXIPROD disponibiliza uma API com endpoints referentes às telas do sistema, que podem ser consumidos por outras aplicações. Em nossa versão atual, disponibilizamos para todos os endpoints o método GET (consulta).
Esta página inclui:
Configurando o token de acesso
Para o acesso à API do ERP MAXIPROD, é exigido um token de segurança, que é gerado a partir do menu 
> Configurações > Configurações da API, através do botão “Gerar token de acesso”.
O token gerado deve ser salvo em um lugar seguro, pois uma vez gerado, não poderá ser novamente consultado no sistema. Em caso de perda, um novo token poderá ser gerado, sobrescrevendo o anterior.
Funcionamento da API
Cada endpoint da API corresponde a uma entidade do ERP MAXIPROD, como notas fiscais, itens, grupos, etc. Utilizando uma ferramenta de integração com APIs ou o próprio navegador, é feita uma requisição HTTP do tipo GET, contendo a URL base, o endpoint e os parâmetros de consulta. Abaixo, são definidas estas variáveis:
URL base: https://sistema.maxiprod.com.br/api/v1/
Endpoints: A lista de endpoints de exportação de dados do ERP MAXIPROD está disponível neste link, ou a partir do menu > API.
Parâmetros:
- token: obrigatório
- PaginaAtual: opcional, se não informado será assumido 1
- TamanhoDePagina: opcional, se não informado será assumido 500. O valor máximo aceito é 5000
Para fazer uma consulta, é necessário combinar a URL base com o endpoint da operação desejada, e em seguida informar o token:
https://sistema.maxiprod.com.br/api/v1/Endpoint?token=INFORMAR_O_TOKEN_AQUI
Os parâmetros PaginaAtual e TamanhoDePagina poderão ser utilizados se houver a necessidade de realizar paginação dos dados. Partindo do exemplo em que existem 2630 registros em um endpoint, caso o tamanho de página seja de 1000 itens, torna-se necessário alterar a página atual de modo a obter todos os registros. Dessa forma, é necessário realizar as seguintes consultas:
https://sistema.maxiprod.com.br/api/v1/Endpoint?token=INFORMAR_O_TOKEN_AQUI&PaginaAtual=1&TamanhoDePagina=1000 (Retorna os registros 1 a 1000)
https://sistema.maxiprod.com.br/api/v1/Endpoint?token=INFORMAR_O_TOKEN_AQUI&PaginaAtual=2&TamanhoDePagina=1000 (Retorna os registros 1001 a 2000)
https://sistema.maxiprod.com.br/api/v1/Endpoint?token=INFORMAR_O_TOKEN_AQUI&PaginaAtual=3&TamanhoDePagina=1000 (Retorna os registros 2001 a 3000)
Na imagem de exemplo abaixo, podemos verificar uma estrutura do retorno fornecido pela API:
PaginaAtual = página atual.
TamanhoDePagina = quantidade máxima de registros por página.
QuantidadeDeRegistros (*) = quantidade total de registros.
QuantidadeDePaginas (*) = quantidade total de páginas.
Registros = lista com os registros.
(*) enviados somente na primeira página
Para evitar o consumo excessivo de recursos, há uma limitação de requisições para cada endpoint. Ou seja, a exportação responderá somente a uma requisição simultânea para cada endpoint/ip por minuto. Em caso de violação desta regra, é gerada uma resposta 429 Too Many Requests.
Endpoints
A lista de endpoints de exportação do ERP MAXIPROD e seus respectivos parâmetros estão disponíveis a partir deste link, ou a partir do menu > API.
Os endpoints tem parâmetros que podem ser utilizados para filtrar ou ordenar os registros, além de carregar informações adicionais. Cada endpoint tem os próprios parâmetros, que podem ser utilizados de maneira conjunta. No exemplo abaixo, são usados como referência os parâmetros do endpoint Itens:
Exemplo de utilização dos parâmetros:
Sem parâmetros:
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}
Retorna todos os itens cadastrados da empresa.
Parâmetro: Código
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Codigo=123
Retorna o item cujo código é 123.
Parâmetros: Código e TipoDeBuscaCodigo
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Codigo=FN&TipoDeBuscaCodigo=Contem
Retorna os itens cujo código contém FN.
Parâmetro: Descrição
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Descricao=Teste
Retorna os itens cuja descrição contém Teste.
Parâmetro: Grupos
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Grupos=9,8,7
Retorna os itens cujo código do grupo é 9, 8 ou 7.
Parâmetro: Estados
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Estados=S,N,D
Retorna os itens cujo estado do mesmo é ativo (S), inativo (N) ou digitação (D).
Parâmetro: OrdenarPor
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&OrdenarPor=Descricao
Ordena o resultado pela descrição dos itens, em ordem crescente (A-Z).
Parâmetro: Incluir
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Incluir=Grupo
Retorna todos os itens e, em cada registro retorna o objeto grupo junto.
Parâmetro: Incluir
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Incluir=Parametros
Retorna todos os itens e, em cada registro retorna uma lista com os parâmetros relacionados.
Parâmetro: Incluir
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Incluir=Grupo,Parametros
Retorna todos os itens e, em cada registro, retorna o grupo e a lista de parâmetros relacionados.
Id do item após o endpoint
https://sistema.maxiprod.com.br/api/v1/Itens/321?token={{token}}
Retorna o item cujo Item_Id é 321.
Exemplos de uso da API
Seguem exemplos de indicadores gerenciais gerados no Power BI:
