Integração NAVIS x SISTER - Documentação - API
O objetivo deste documento é explicar como se dará o acesso e a utilização da API desenvolvida pela eProfessionalTI, que fará a integração dos movimentos de entrada e saída de containers no porto.
A proposta deste projeto é a disponibilização de uma API para qual o sistema Cliente possa usá-la para enviar os dados das Entradas e Saídas dos containers do Sistema do Porto para o SISTER (Sistema de Gestão de Containers Vazios) que está no Depósitos, de forma automática e em tempo real.
A Web API que será disponibilizada, foi desenvolvida na plataforma Microsoft, usando a linguagem C#.Net, os parametros informados e os resultados na integração, utilizam como padrão o formato JSON, formato este já consolidado e em uso em diversas aplicações corporativas.
I - Requisição:
O meio de autenticação escolhido para a API é o Digest, onde primeiramente o usuário obtém uma Chave, mediante o envio do CNPJ do Depósito. Caso o CNPJ fornecido seja válido, a API retornará uma Chave, que deverá ser usada no próximo acesso a API, para o método desejado. Vale lembrar que a Chave terá validade de um dia, após este período uma nova Chave deverá ser obtida.
Para obter a Chave, o programa cliente deve acessar as seguintes URLs:
http://URL_CLIENTE/api/integra/access/get
O método em questão utiliza uma requisição post e o seguinte JSON deve ser enviado:
II - Retorno
O retorno terá o atributo SUCCESS para retornar Verdadeiro ou Falso, caso o retorno seja Falso, o Atributo ERROR, trará a descrição do erro, caso contrário ele será vazio. Um terceiro atributo é o OBJECT, que contém a Chave usada para o acesso ao método desejado da API.
I - Requisição:
Caso a autenticação do CNPJ do Depósito tenha sido feita com sucesso, o sistema cliente deverá usar o dado retornado (OBJECT)(CHAVE) para acessar o método /movimentacao/entrada. O Acesso a este método dever ser feito através da seguinte URL:
http://URL_CLIENTE/api/integra/movimentacao/entrada
O método em questão utiliza uma requisição post e o seguinte JSON deve ser enviado:
II - Retorno
O retorno terá o atributo SUCCESS para retornar Verdadeiro ou Falso, caso o retorno seja Falso, o Atributo ERROR, trará a descrição do erro, caso contrário ele será vazio.
I - Requisição:
Caso a autenticação do CNPJ do Depósito tenha sido feita com sucesso, o sistema cliente deverá usar o dado retornado (OBJECT)(CHAVE) para acessar o método /movimentacao/saida. O Acesso a este método dever ser feito através da seguinte URL:
http://URL_CLIENTE/api/integra/movimentacao/saida
O método em questão utiliza uma requisição post e o seguinte JSON deve ser enviado:
II - Retorno
O retorno terá o atributo SUCCESS para retornar Verdadeiro ou Falso, caso o retorno seja Falso, o Atributo ERROR, trará a descrição do erro, caso contrário ele será vazio.