Entenda como funciona a API do eGestor!

Escrito em: 26/04/18
Início 9 Sistema de Gestão 9 Entenda como funciona a API do eGestor!

O eGestor possui uma API rest que possibilita aos usuários do sistema, o acesso as mais variadas ferramentas, como produtos, contatos, vendas, serviços, recebimentos, pagamentos e boletos bancários.

A sigla REST ou Representational State Transfer, em português significa Transferência do Estado Representacional. A API rest é portanto uma interface que não necessita do uso de sessões para o acesso as ferramentas de determinado sistema, conforme ocorre nos navegadores. A API rest do eGestor possibilita aos usuários a realização das seguintes funcionalidades no sistema:

  • Inserir recebimentos no menu financeiro e gerar boleto bancário;
  • Analisar dados da rede de contatos, sejam eles clientes, fornecedores ou transportadores;
  • Criar vendas e preencher as mais variadas informações referentes aos clientes envolvidos no negócio e aos produtos vendidos;

Biblioteca da API

A biblioteca PHP é a ferramenta da API REST do eGestor que permite a integração do sistema com outras plataformas, de uma forma totalmente simples e ágil.

Métodos de requisições

As requisições na API do eGestor podem ser feitas por 4 métodos:

  • GET: tem como função retornar informações de um registro para outro;
  • POST: é um método de requisição utilizado para criar um novo registro, como um novo cadastro de compra ou venda, por exemplo; 
  • PUT: permite a atualização de um determinado registro ou a mudança de uma situação, como por exemplo a alteração de status de uma conta a pagar ou receber, de pendente para concluída ou então a modificação de informações referentes a determinada compra ou venda cadastrada no sistema;
  • Delete: possibilita a remoção de um registro feito no sistema, seja de uma compra, venda ou produto cadastrado, dentre outras opções;

Respostas

Após a solicitação de determinada requisição por parte do usuário, o sistema pode gerar as seguintes respostas:

  • Código 2000: requisição executada com sucesso;
  • Código 400: erros de validação ou os campos informados não existem no sistema;
  • Código 401: dados de acessos inválidos;
  • Código 404: registro pesquisado não encontrado (Not found); 
  • Código 405: método não implementado;
  • Código 410: registro pesquisado foi apagado do sistema e não se encontra mais disponível;
  • Código 422: dados informados estão fora do escopo definido para o campo;
  • Código 429: número máximo de requisições atingido (aguarde alguns segundos e tente novamente)

Limites de requisições

O limite de requisições que podem ser solicitadas é de 60 por minuto a cada aplicação feita por um determinado usuário. Os limites podem ser devidamente acompanhados nos seguintes headers da API: X-RateLimit, X-RateLimit – Remaining que são enviados em todas as respostas da API. Para questões de segurança, é recomendável que todas as requisições sejam feitas por meio do protocolo HTTPS.

Listar

As ações de listar permitem o envio de dois parâmetros:

  • Filtro: segmenta os dados de acordo com o valor informado;
  • Page: informa qual página que possui a necessidade de ser retornada;

Se houver qualquer dúvida em relação a erros nas requisições ou a respeito de qualquer outra situação da API do eGestor, entre em contato com o suporte da Zipline Tecnologia, empresa desenvolvedora do sistema eGestor. O contato pode ser feito por meio do endereço de e-mail suporte@zipline.com.br.

eGestor - Software online de gestão empresarial para pequenas empresas

 

<a href="https://blog.egestor.com.br/author/pedro-henrique-escobar/" target="_self">Pedro Henrique Escobar</a>

Pedro Henrique Escobar

Pedro Henrique Escobar é formado em Administração e gerente de marketing no eGestor. O eGestor é uma ferramenta online para gestão de micro e pequenas empresas. Teste gratuitamente em: eGestor.

Você também pode gostar…

Planilha de Preço de Venda e Promoção: Calcule grátis

Download Grátis Definir o preço de venda e promoção de um produto até parece ser uma tarefa fácil, mas quem é empreendedor sabe que é uma responsabilidade enorme. Isso porque um cálculo errado pode atrapalhar os lucros do negócio, mesmo...

Planilha de Custo Médio: Download Grátis

Download Grátis Quando falamos em gestão eficiente de empresas, não podemos deixar de falar em controle de estoque. Quem entende que um bom gerenciamento de produtos armazenados é fundamental para o sucesso, está no caminho certo. Afinal,...

Planilha de Controle de Produção [Download Grátis]

Download Grátis A maioria dos produtos comprados pelos consumidores são resultados de transformações de uma matéria-prima. E alguém deve fazer essa transformação. Por isso, existem empresas responsáveis por realizar essas alterações. Elas...

Planilha de custo de funcionário: Como realizar o cálculo

Download Grátis Quando decide contratar um funcionário, o empreendedor costuma pensar no salário que terá que pagar todos os meses, mas nem sempre se dá conta do custo total deste colaborador para a empresa. Você também é assim? Pois...

Planilha de DRE: Modelo para download [Grátis]

Download Grátis A Demonstração do Resultado do Exercício (DRE) faz parte da gestão financeira de empresas e empreendedores. A sigla é bastante conhecida em escritórios de contabilidade por ajudar a manter um controle periódico de todas as...

Planilha de Ordem de Serviço: Download do Modelo Grátis!

Download Grátis A planilha de ordem de serviço é um dos documentos mais comuns entre as empresas prestadoras de serviço. Ela é uma forma de organizar e distribuir os pedidos recebidos pelo setor comercial da organização, repassando-os...

Planilha de Orçamento Empresarial [DOWNLOAD GRÁTIS]

Download Grátis Orçamento, segundo o dicionário é o ato de orçar, ou seja, fazer um cálculo para chegar a estimativa de gasto de um projeto. Esse projeto pode ser de vários tipos. Ele pode ser orçamento para uma viagem, para um casamento,...

Planilha de controle de estoque Excel: Download grátis [Atualizada 2022]

Receba por e-mail Receba por Whatsapp 📞 O controle de estoque é fundamental para a sobrevivência de uma micro ou pequena empresa, afinal, é com ele que você conhece sobre a reserva de produtos do negócio. Assim, uma boa gestão de estoque...

Planilha de Fluxo de Caixa 2022 – Grátis e fácil

Download Grátis O download da planilha de Fluxo de Caixa é grátis? Sim, o download da planilha de fluxo de caixa do eGestor é totalmente gratuito. Para evitar problemas relacionados à versão do Excel, sugerimos a utilização no Google...

Planilha de Análise SWOT: Baixe agora! [Download Grátis]

Download Grátis Em algum momento da sua vida como empreendedor você já deve ter ouvido falar em análise SWOT. Principalmente se for para falar em como ela é importante para tirar os projetos do papel e fazê-los dar certo. Mas, você sabe...

0 comentários

Enviar um comentário

O seu endereço de e-mail não será publicado.

error: Conteúdo protegido.