API ERP MAXIPROD

API ERP MAXIPROD

A API (Application Programming Interface) é um conjunto de recursos e padrões utilizados para a integração entre ferramentas. O ERP MAXIPROD disponibiliza uma API de exportação de dados 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 a utilização da API do ERP MAXIPROD, é exigido um token de segurança para acessar as informações correspondentes aos dados da empresa. Este token é gerado a partir do menu  > Configurações > Configurações de segurança, 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. Caso o token seja perdido, 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 (token, página, etc.), nesta ordem. Abaixo, são definidas estas variáveis:

URL base: https://sistema.maxiprod.com.br/api/v1/

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

Os parâmetros devem ser informados na própria URL, por exemplo:
https://sistema.maxiprod.com.br/api/v1/CentrosDeCustos?token=INFORMAR_O_TOKEN_AQUI&PaginaAtual=1&TamanhoDePagina=3

Neste exemplo, é retornado um arquivo no formato JSON com a primeira página (PaginaAtual=1), com 3 registros (TamanhoDePagina=3), no formato:

{
  "PaginaAtual": 1,
  "TamanhoDePagina": 3,
  "QuantidadeDeRegistros": 156,
  "QuantidadeDePaginas": 53,
  "Registros": [
    {
      "Centro_custos_Id": 73935,
      "Descricao": "RECEITAS",
      "Classificacao": "Sintética",
      "Tipo_custeio": "Direto"
    },
    {
      "Centro_custos_Id": 73881,
      "Descricao": "C.04 Material para teste de maquinas",
      "Classificacao": "Analítica",
      "Tipo_custeio": "Indireto"
    },
    {
      "Centro_custos_Id": 73590,
      "Descricao": "Emprestimos",
      "Classificacao": "Analítica",
      "Tipo_custeio": "Direto"
    },
    ]
}

Onde:
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 = array 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 API 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

Segue a lista de endpoints disponíveis na API do ERP MAXIPROD:

GET Anotacoes
Endpoint utilizado para consulta de anotações da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Anotacoes?token={{token}}

GET Apontamentos
Endpoint utilizado para consulta de apontamentos da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Apontamentos?token={{token}}

GET CentrosDeCustos
Endpoint utilizado para consulta dos centros de custos da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/CentroDeCustos?token={{token}}

GET CentrosDeTrabalho
Endpoint utilizado para consulta dos centros de trabalho da empresa.

Filtros e Ordenação (Params)

Filtros e Ordenação (Params)

Filtros
Codigo=(Código do centro de trabalho)
Ativo=(S=ativos, N=inativos)

Ordenação
OrdenarPor=Centro_de_trabalho_Id
OrdenarPor=Codigo
OrdenarPor=Descricao
OrdenarPor=Descricao_dec (ordem decrescente, Z-A)

Exemplos

https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho?token={{token}}
Trará todos os centros de trabalho cadastrados da empresa.
https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho?token={{token}}&Codigo=123
Trará o centro de trabalho cujo código seja igual à 123.
https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho?token={{token}}&Ativo=S
Trará todos os centros de trabalho ativos.
https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho?token={{token}}&OrdenarPor=Descricao
Ordenará o resultado por descrição dos centros de trabalho em ordem crescente (A-Z).
https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho?token={{token}}&OrdenarPor=Descricao_dec
Ordenará o resultado por descrição dos centros de trabalho em ordem decrescente (Z-A).
https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho?token={{token}}&OrdenarPor=Descricao_dec,Centro_de_trabalho_Id
Ordenará o resultado por descrição dos centros de trabalho em ordem decrescente (Z-A) e por ID do centro de trabalho.

GET CentrosDeTrabalho/{{id}}
Endpoint utilizado para consulta do centro de trabalho por Centro_de_trabalho_Id.
Exemplo

https://sistema.maxiprod.com.br/api/v1/CentrosDeTrabalho/321?token={{token}}
Trará o centro de trabalho cujo o Centro_de_trabalho_Id seja igual à 321.

GET ContasContabeis
Endpoint utilizado para consulta das contas contábeis da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ContasContabeis?token={{token}}

GET Contatos
Endpoint utilizado para consulta dos contatos da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Contatos?token={{token}}

GET Cotacoes
Endpoint utilizado para consulta das cotações da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Cotações?token={{token}}

GET Estoques
Endpoint utilizado para consulta dos estoques da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Estoques?token={{token}}

GET EstoquesMovimentacoes
Endpoint utilizado para consulta das movimentações de estoque da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/EstoquesMovimentacoes?token={{token}}

GET Empresas
Endpoint utilizado para consulta das empresas cadastradas.

Filtros e Ordenação (Params)

Filtros e Ordenação (Params)

Filtros
incluirCamposAdicionais=(true)

Exemplos

https://sistema.maxiprod.com.br/api/v1/Empresas?token={{token}}
Trará todas as empresas sem os campos adicionais
https://sistema.maxiprod.com.br/api/v1/Empresas?token={{token}}&incluirCamposAdicionais=true
Trará todas as empresas e seus campos adicionais

GET Grupos
Endpoint utilizado para consulta dos grupos da empresa.

Filtros e Ordenação (Params)

Filtros e Ordenação (Params)

Filtros
GrupoPai=(Código do grupo pai)
Estados=(S=ativos, D=digitação, N=Inativos)

Ordenação
OrdenarPor=Grupo_Id
OrdenarPor=Codigo
OrdenarPor=Descricao
OrdenarPor=Descricao_dec (ordem decrescente, Z-A)

Exemplos

https://sistema.maxiprod.com.br/api/v1/Grupos?token={{token}}
Trará todos os grupos cadastrados da empresa.
https://sistema.maxiprod.com.br/api/v1/Grupos?token={{token}}&GrupoPai=123
Trará os grupos cujo cujo código do grupo pai seja igual à 123.
https://sistema.maxiprod.com.br/api/v1/Grupos?token={{token}}&Estados=S,D
Trará todos os grupos cujo o estado seja Ativo(S) ou Digitação(D)
https://sistema.maxiprod.com.br/api/v1/Grupos?token={{token}}&OrdenarPor=Descricao
Ordenará o resultado por descrição dos grupos em ordem crescente (A-Z).
https://sistema.maxiprod.com.br/api/v1/Grupos?token={{token}}&OrdenarPor=Descricao_dec
Ordenará o resultado por descrição dos grupos em ordem decrescente (Z-A).
https://sistema.maxiprod.com.br/api/v1/Grupos?token={{token}}&OrdenarPor=Descricao_dec,Grupo_Id
Ordenará o resultado por descrição dos grupos em ordem decrescente (Z-A) e por ID do grupo.

GET Grupos/{{id}}
Endpoint utilizado para consulta do grupo por Grupo_Id.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Grupos/321?token={{token}}
Trará o grupo cujo o Grupo_Id seja igual à 321.

GET Impostos
Endpoint utilizado para consulta dos impostos da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Impostos?token={{token}}

GET Itens
Endpoint utilizado para consulta dos itens da empresa.

Filtros e Ordenação (Params)

Filtros e Ordenação (Params)

Filtros
Codigo=(Código do item)
TipoDeBuscaCodigo=(Igual, Contem, IniciaCom)
Descricao=(Descrição do item) *Contém
Grupos=(Código do grupo)
Estados=(S=ativos, D=digitação, N=Inativos)

Ordenação
OrdenarPor=Item_Id
OrdenarPor=Codigo
OrdenarPor=Descricao
OrdenarPor=Descricao_dec
(ordem decrescente, Z-A)

Parâmetros
Incluir=Grupo
Incluir=Parametros
Incluir=Grupo,Parametros

Exemplos

https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}
Trará todos os itens cadastrados da empresa.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Codigo=123
Trará o item cujo o código seja igual à 123.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Codigo=FN&TipoDeBuscaCodigo=Contem
Trará todos os itens cujo o código contenha FN.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Descricao=Teste
Trará todos os itens cuja a descrição contenha Teste.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Grupos=9,8,7
Trará todos os itens cujo o código do grupo seja 9, 8 ou 7.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&OrdenarPor=Descricao
Ordenará o resultado por descrição dos itens em ordem crescente (A-Z).
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Incluir=Grupo
Trará todos os itens e um objeto grupo junto.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Incluir=Parametros
Trará todos os itens e uma coleção com todos os parâmetros de cada item.
https://sistema.maxiprod.com.br/api/v1/Itens?token={{token}}&Incluir=Grupo,Parametros
Trará todos os itens, com grupo e uma coleção com todos os parâmetros de cada item.

GET Itens/{{id}}
Endpoint utilizado para consulta do item por Item_Id.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Itens/321?token={{token}}
Trará o Item cujo o Item_Id seja igual à 321.

GET ItensEstrutura
Endpoint utilizado para consulta da estrutura dos itens da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ItensEstrutura?token={{token}}

GET ItensRoteiro
Endpoint utilizado para consulta dos roteiros dos itens da empresa.

Filtros e Ordenação (Params)

Filtros e Ordenação (Params)

Filtros
CodigoItem=(Código do item)

Ordenação
OrdenarPor=Operacao
OrdenarPor=Descricao

Exemplos

https://sistema.maxiprod.com.br/api/v1/ItensRoteiro?token={{token}}
Trará as atividades do roteiro de todos os itens cadastrados na empresa.
https://sistema.maxiprod.com.br/api/v1/ItensRoteiro?token={{token}}&CodigoItem=123
Trará todas as atividades do roteiro do item com código igual à 123.
https://sistema.maxiprod.com.br/api/v1/ItensRoteiro?token={{token}}&OrdenarPor=Operacao
Ordenará o resultado por operação.
https://sistema.maxiprod.com.br/api/v1/ItensRoteiro?token={{token}}&OrdenarPor=Descricao_dec
Ordenará o resultado por descrição em ordem decrescente (Z-A).
https://sistema.maxiprod.com.br/api/v1/ItensRoteiro?token={{token}}&OrdenarPor=Descricao,Centro_de_trabalho_Id
Ordenará o resultado por descrição em ordem crescente (A-Z) e por operação.

GET ItensDasCotacoes
Endpoint utilizado para consulta dos itens das cotações da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ItensDasCotacoes?token={{token}}

GET ItensDasNotas
Endpoint utilizado para consulta dos itens das notas da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ItensDasNotas?token={{token}}

GET ItensDosPedidosDeCompra
Endpoint utilizado para consulta dos itens dos pedidos de compra da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ItensDosPedidosDeCompra?token={{token}}

GET ItensDosPedidosDeVenda
Endpoint utilizado para consulta dos itens dos pedidos de venda da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ItensDosPedidosDeVenda?token={{token}}

GET ItensDasPropostas
Endpoint utilizado para consulta dos itens das propostas da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ItensDasPropostas?token={{token}}

GET LancamentosContabeis
Endpoint utilizado para consulta dos lançamentos contábeis da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/LancamentosContabeis?token={{token}}

GET Notas
Endpoint utilizado para consulta das notas da empresa
Exemplo

https://sistema.maxiprod.com.br/api/v1/Notas?token={{token}}

GET NotasReferenciadas
Endpoint utilizado para consulta das notas referenciadas.
Exemplo

https://sistema.maxiprod.com.br/api/v1/NotasReferenciadas?token={{token}}

GET Operacoes
Endpoint utilizado para consulta das operações da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Operacoes?token={{token}}

GET OperacoesFiscais
Endpoint utilizado para consulta das operações fiscais da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/OperacoesFiscais?token={{token}}

GET OrdensDeProducao
Endpoint utilizado para consulta das ordens de produção da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/OrdensDeProducao?token={{token}}

GET ParametroDeItens
Endpoint utilizado para consulta dos parâmetros dos itens da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/ParametroDeItens?token={{token}}

GET PedidosDeCompra
Endpoint utilizado para consulta dos pedidos de Compra da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/PedidosDeCompra?token={{token}}

GET PedidosDeVenda
Endpoint utilizado para consulta dos pedidos de venda da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/PedidosDeVenda?token={{token}}

GET Propostas
Endpoint utilizado para consulta das propostas da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Propostas?token={{token}}

GET SolicitacoesDeCompra
Endpoint utilizado para consulta das solicitações de compra da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/SolicitacoesDeCompra?token={{token}}

GET Titulos
Endpoint utilizado para consulta dos titulos da empresa.
Exemplo

https://sistema.maxiprod.com.br/api/v1/Titulos?token={{token}}

Disponibilizamos um arquivo da ferramenta Postman, contendo todos os endpoints acima devidamente parametrizados.