Integração API


PARA REALIZAR UMA REQUISIÇÃO EM AMBIENTE DE PRODUÇÃO USE HTTPS EX. https://sistema.erpflex.com.br/api

PARA REALIZAR UMA REQUISIÇÃO EM AMBIENTE DE TESTE USE HTTP EX. http://implantacaoapi.erpflex.com.br/api

Atenção!!

Eventualmente, o serviço da API pode parar de responder.

Isso ocorre porque de tempos em tempos, a base de dados é atualizada com uma cópia da base de produção.

Se você perceber uma instabilidade nas respostas da API, por favor, aguarde alguns minutos e tente novamente.

Primeiros Passos

Para iniciar o desenvolvimento de sua aplicação utilizando a API de integração, siga as orientações para que seja disponibilizado um ambiente de “desenvolvimento” a fim de realizar seus testes antes de levar sua aplicação para o ambiente oficial de “produção”.

Enviei um e-mail ao administrador da rede (api@erpflex.com.br)  conforme orientações abaixo:

  • Cliente: (Empresa/Razão Social cadastrada no ERPFlex)
    Ex. Minha Empresa Ltda
  • CNPJ: (CNPJ cadastrado no ERPFlex)
    Ex.12345678000199
  • Nome da Base: (Base que o cliente acessa dentro do ERPFlex)
    Ex. Minha Empresa Matriz Ltda
  • Empresa: (Empresa responsável pela integração)
    Ex. Integradora Ltda
  • Nome: (Nome do responsável pela integração)
    Ex. Fulano da Silva
  • E-mail (Contato do desenvolvedor)
    Ex. fulano@integradora.com.br
  • Usuário: (Nome de um usuário para acesso a API – não é necessário ser o mesmo do ERPFlex)
    Ex. api.empresa
  • Senha: (Senha para este usuário, mínimo 8 caracteres)
    Ex. 1a2b3c4d
  • Mensagem: (Caso queira informar algum detalhe adicional)

Importante

Evite utilizar nomes de usuários comuns, pois estes podem conflitar com outros usuários já existente e/ou com usuários de utilização interna.

➡ Segue abaixo uma lista de usuários que devem ser evitados:

  • admin
  • administrador
  • administrator
  • owner
  • api
  • usuario
  • user
  • sistema
  • system
  • erp

Como sugestão, tente fornecer usuários que tenham mais de uma composição, podendo ser separados por ponto (.), traço (-), underline (_), etc.

➡ Segue algumas sugestões de exemplo:

  • admin_nomedaempresa
  • api_nomedaempresa
  • nomedaempresa_api
  • administrador.nomedaempresa

Notas sobre este documento

Este manual foi escrito usando código exemplo em PHP e utilizando a biblioteca Pest para facilitar o uso e entendimento.

Para utilizar o Pest, faça download desta bilioteca em https://github.com/educoder/pest e inclua o código em seu fonte php usando:

<?php require "pestJSON.php"; ?>

Nossa API é em formato REST, portanto, se a sua linguagem de desenvolvimento consegue realizar uma requisição HTTP, você poderá utilizá-la.

A API retorna dados no formato XML Para envio de dados à API, deve-se utilizar o formato JSON (no cabeçalho HTTP/1.1, utilizar “Content Type : application/json”).
 
Para informações sobre os recursos disponibilizados nesta API, navegue do menu disponível no lado esquerdo dessa tela.