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

 

Escrito por eGestor
O eGestor é um software online para gestão de micro e pequenas empresas. Teste gratuitamente em: https://www.egestor.com.br