A comunicação com a API ConectorGate é feita através de requisições em protocolo HTTP (modelo REST), e os dados são comunicados em formato JSON. A forma de acesso aos dados do ERP é muito parecida com um navegador de internet, exceto que há exigência de credenciais para autorização de uso.
O protocolo HTTP é utilizado pelos navegadores para se comunicar com servidores web, através dos métodos CRUD (GET, POST, PUT e DELETE). Você irá utilizar estes mesmos métodos para fazer leitura, cadastro e atualização de registros em nossa API.
É possível desenvolver a comunicação ou integração com a API ConectorGate em qualquer linguagem de programação que permita manipulação de conexão e requisições HTTP. A maioria das linguagens de programação possuem bibliotecas nativas ou senão de terceiros (necessita baixar e instalar) para este tipo de operação. Na documentação Postman da API ConectorGate há inúmeros exemplos em inúmeros linguagens de programação.
Após a API ConectorGate estar instalada e ativada no ambiente ERP, o modo mais simples de utilizá-la é com aplicações de testes de API que permitam conexões e requisições HTTP. Exemplo: SoapUI, Postman.
Instalação, Setup e Ativação
O processo de instalação, setup e ativação da API ConectorGate é muito rápida. Com os acessos ao ambiente do ERP (SAP B1If ou server TOTVS) e as regras mínimas para o Setup, no prazo de até 5 dias úteis a API ConectorGate estará disponível para uso.
Veja mais sobre a infraestrutura de aplicações utilizada pela API ConectorGate: CLIQUE AQUI
Veja mais sobre o Setup da API ConectorGate: CLIQUE AQUI
Utilizando a API ConectorGate
A API ConectorGate pode ser utilizada por RPA desenvolvido para uma automação ou integração específica, ou pode ser utilizada por uma plataforma de integração iPaaS para integrar o ERP com outras plataformas especialistas, ou pode ser utilizada para o desenvolvimento de aplicações web ou mobile interagindo em realtime com o ERP, ou ainda pode ser utilizada para requests manuais utilizando ferramentas como SoapUI e Postman,
Veja mais sobre a Documentação Postman da API ConectorGate, baixe a collection e veja como testar a API ConectorGate pelo Postman: CLIQUE AQUI
Veja como pesquisar registros na API ConectorGate utilizando paginação e consulta incremental: CLIQUE AQUI
Detalhes específicos:
- Veja mais sobre produtos, preços e estoques na API ConectorGate: CLIQUE AQUI
- Veja mais sobre pedidos, preços e impostos na API ConectorGate: CLIQUE AQUI
- Veja mais sobre pedidos com adiantamento na API ConectorGate: CLIQUE AQUI
Detalhes Técnicos
Alguns detalhes técnicos são importantes para uma utilização efetiva da API ConetorGate.
A API ConectorGate é uma solução fracamente acoplada, o que significa que não interfere ou interfere minimamente no ERP. Entre os diferenciais da API ConectorGate estão a possibilidade de personalização de campos e o Portal de Monitoramento web (utilização e transações). Para a implementação destes diferenciais a API ConectorGate apenas necessita que quatro tabelas de usuário sejam criadas no banco de dados do ERP.
- Veja mais sobre a tabela de usuário para Personalização de Campos: CLIQUE AQUI
- Veja mais sobre as tabelas de usuário para Monitoramento (utilização e transações): CLIQUE AQUI
- Veja mais sobre a tabela de usuário para Pagamentos: CLIQUE AQUI
A API ConectorGate também define uma padronização para identificação dos objetos de negócio no ERP e da chave primária de cada objeto no ERP. Em todos os objetos de negócio do ERP a chave primário sempre será o campo erpKey, e a referência ao campo no ERP depende do ERP em si e do objeto de negócio/tabela envolvido.
- Veja mais sobre a autenticação de usuário utilizada pela API ConectorGate: CLIQUE AQUI
- Veja mais sobre a chave primária dos objetos de negócio no ERP: CLIQUE AQUI
- Veja mais sobre o status dos retornos da API ConectorGate: CLIQUE AQUI
Changelog
A API ConectorGate está em constante evolução, agregando gradativamente novos serviços, recursos e inteligência na interação com o ERP.
Veja mais sobre o Changelog da API ConectrGate: CLIQUE AQUI