Existem várias formas de integrar seus próprios sistemas, ou sistemas de terceiros, ao Gestor Logístico. Geralmente o caminho mais simples e rápido de ser implementado é através da troca de arquivos, usando e-mail ou SFTP.
Existem alguns padrões de mercado estabelecidos para a troca de dados mais comuns, como notas fiscais, conhecimentos, ocorrências e faturas, via EDI (Eletronic Data Interchange). Veja aqui mais detalhes sobre a implementação deste formato no GL.
Essas soluções funcionam bem em muitos casos, mas infelizmente não conseguem atender todas as situações onde a troca automática de dados entre sistemas é necessária. Por exemplo, um portal de venda on-line (e-commerce) precisa receber o valor do frete de forma on-line, para exibir ao usuário no momento do check-out. Neste caso, esse portal precisaria enviar os dados dos produtos para o Gestor Logístico, que irá fazer o cálculo do frete até o local de destino, e devolver imediatamente essa informação para o sistema de e-commerce.
É para resolver essa e muitas outras situações que o Gestor Logístico disponibiliza um conjunto de web services que permite a sistemas de terceiros "interagir" de forma automatizada, em tempo real, otimizando processos ou integrações. Este conjunto de "web services" é chamado de API, que é a abreviação de Application Programming Interface (interface de programação de aplicações).
Considerações preliminares
Utilizar a API do GL é a forma mais eficiente e segura para realizar a integração dos seus sistemas com o GL. O processo pode ser totalmente automatizado, os dados podem ser atualizados imediatamente, a comunicação é feita através de canais seguros e criptografados, sem a possibilidade de acessos não autorizados aos dados, e todo o processo pode ser monitorado automaticamente.
Porém, é preciso ter em mente que tudo tem um custo! E apesar de ser o meio mais eficiente, é também o mais complexo para ser implementado. Você vai precisar envolver o time de TI da sua empresa, para que entendam o formato e as particularidades da nossa API, e desenvolvam um aplicativo "sob medida" para fazer o envio.
Além disso, como o processo será totalmente automatizado, e portanto (geralmente) sem nenhuma intervenção humana, esse processo precisa ser suficientemente "inteligente" para se recuperar sozinho de qualquer falha durante o envio. Por exemplo, pode ser que ocorra alguma indisponibilidade temporária da internet, exatamente no momento que o seu sistema está tentando enviar uma Nota Fiscal ou fazer uma cotação de frete. Apesar de muito raro, isso pode ocorrer, e essas excessões precisam ser tratadas pelo seu aplicativo, para que ele tente novamente o envio posteriormente, quando todos os componentes da solução estiverem novamente operantes.
Especificações técnicas
A tecnologia adotada para implementação desta API é a RESTful, que é o formato mais comum atualmente utilizado para esse tipo de integração. Nesta arquitetura, os sistemas trocam dados no formato JSON, que é um formato compacto e flexível para a troca de dados.
A segurança na comunicação é garantida pelo protocolo HTTPS, onde todos os dados são transmitidos de forma criptografada.
Todos os acessos à API precisam ser autenticados e autorizados, ou seja, a aplicação que vai fazer o acesso ao GL precisa enviar algumas informações que permitem confirmar que ela está autorizada a realizar o serviço que está solicitando.
Autenticação
Obviamente, o acesso à API somente será autorizado se você possuir as "credenciais" que provem que você (ou melhor, neste caso a sua aplicação), está autorizada a realizar as transações. E para isso você vai precisar ter um usuário cadastrado no sistema com os direitos necessários. Se tiver qualquer dúvida em como cadastrar este usuário, basta enviar um e-mail para o nosso time de suporte, ou com o consultor que atende sua empresa, e eles podem fazer isso por você.
O protocolo de autenticação utilizado é o Basic Authentication, de forma que é preciso um nome de usuário e uma senha para autorizar o acesso. As funções da aplicação que serão disponibilizadas dependem dos direitos que foram atribuídos a este usuário.
Serviços mais comuns
Praticamente todas as funcionalidades do Gestor Logístico estão disponíveis para acesso via API, mas infelizmente nem todas já estão devidamente documentadas.
Os serviços abaixo são os que mais comumente fazem uso da API, e portanto são os que estão melhor documentados:
Caso você esteja procurando implementar algum processo diferente dos que estão listados aqui, entre em contato com nossa equipe para que possamos lhe auxiliar.
Documentação
A documentação completa da API encontra-se aqui, e sua versão atual em ambiente de produção pode ser acessada através da URL https://api12.gestorlogistico.com.br.