fbpx

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
Início 9 Sistema de Gestão 9 Entenda como funciona a API do eGestor!
Escrito em: 26/04/18
<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.

Comentários:

Compartilhe seu comentário, dúvida ou sugestão!

0 comentários

Enviar um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *

Você também pode gostar…

NFC-e (Nota fiscal de consumidor eletrônica) [Atualizado]

Emitir NFC-e Todo produto ou serviço vendido, deve ter sua comprovação fiscal e um dos meios de atestar essa transação é a nota fiscal. Afinal, ela dá segurança tanto à empresa que vende o produto, quanto ao consumidor que o compra....

Fluxo de Caixa: Guia de como fazer o da sua empresa

O que é o fluxo de caixa?O fluxo de caixa é o controle de todos os valores que entram e saem do financeiro da empresa. Qual o objetivo do fluxo de caixa?O objetivo do fluxo de caixa é garantir a saúde financeira do negócio, assegurando...

Nota Fiscal de Serviço Eletrônica (NFS-e): o que é e quem emite

A NFS-e, ou Nota Fiscal de Serviço Eletrônica, é um dos tipos de notas fiscais que existe juntamente com a nota fiscal, a nota fiscal do consumidor e o conhecimento de transporte. Elas são úteis para empresas que tem como uma das funções...

Gestão empresarial: guia definitivo para o sucesso do seu negócio

Toda empresa precisa ter um objetivo, uma missão maior que guie todas as suas atividades. Independente de qual for esse objetivo, ele tem tudo a ver com a gestão empresarial. Isso porque é através de uma gestão empresarial competente e...

Nota fiscal eletrônica: tudo o que você deve saber [ATUALIZADO]

A Nota Fiscal Eletrônica (NF-e) é um documento cuja função é atestar a venda de um produto ou a prestação de um serviço. Ela foi desenvolvida com o objetivo de substituir alguns sistemas de impressão de documentos fiscais em papel. Assim...

Controle financeiro empresarial: Como fazer passo a passo

Passo a passo para fazer o controle financeiro da sua empresa Faça o controle do fluxo de caixa Separe custos e receitas Planejamento de recebimentos e pagamentos Registre todas as operações financeiras Tenha um orçamento bem estruturado...

Controle de Estoque: Como fazer um controle profissional

Porque o controle de estoque é tão importante para a empresa? O estoque é o principal ativo de uma empresa, sendo a forma mais importante de fazer dinheiro. Por isso, ter total atenção a gestão do estoque é de extrema importância. Se a...

ERP: O que é e vantagens [GUIA COMPLETO]

Teste Grátis A administração de uma empresa acontece diariamente, com processos e controle que devem ser feitos a todo momento. Esses processos são o que mantém a empresa funcionando, e esse controle é o que mantém as contas em dia e os...

Faturamento: O que é, como calcular e aumentar o seu

Porque o faturamento é tão importante para a empresa? Porque ele é o valor, em dinheiro, que a empresa recebeu em um período. Assim, ele demonstra se o resultado foi satisfatório ou não. Com o acompanhamento se tem uma melhor ideia da...

Guia do MEI: Tudo sobre o MEI – Blog do eGestor

O MEI (Microempreendedor Individual) é um tipo de empresa voltado para formalização de profissionais autônomos. O custo para abrir um MEI é zero. Os impostos pagos pelo MEI são o ICMS, pela venda de mercadorias, o ISS, por prestação de...