O objetivo deste documento é explicar como se dará o acesso a API desenvolvida pela eProfessionalTI, que faz a integração dos movimentos de entrada dos Containers vazios de Devolução de Importação e também a Liberação de Vazios para Exportação para Ovação/Estufagem nos Depósitos através do sistema Cliente (WMS).
Breve descritivo do projeto
A proposta deste projeto é a disponibilização de uma API para qual o sistema Cliente (WMS) possa usá-la para enviar os dados dos Containers vazios aos Depósitos de forma automática e em tempo real nos processos de Devolução de Importação e Liberação de Vazios para Exportação para Ovação/Estufagem
Característica técnicas
A Web API que será disponibilizada, foi desenvolvida na plataforma Microsoft, usando a linguagem C#.Net, A mensageria prevista na integração, usará como padrão o formato JSON, formato este já consagrado e em uso em diversas corporações.
Autenticação na API
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 a permissão de acesso
Para obter a Chave, o programa cliente (WMS). deve acessar as seguintes URLs:
• Teste - "http://websister.eprofessionalti.com/api/integra/access/get"
O método em questão é post e o seguinte JSON deve ser enviado: JSON para a requisição:
DEPOT - CNPJ do Depósito
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.
Entrada do container no depósito
I - Requisição:
Caso a autenticação do CNPJ do Depósito tenha sido feita com sucesso, o sistema cliente (WMS) deverá usar o dado retornado (CHAVE) para acessar o método devolucaoimportacao. O Acesso a este método dever ser feito através das seguintes URLs:
• Teste – “http://websister.eprofessionalti.com/api/integra/wmsprecadreceb/devolucaoimportacao"
O método em questão é post e o seguinte JSON deve ser enviado:
JSON para a requisição:
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.
Saída do container do depósito
O Container sairá do sistema do Depósito através do processo de Liberação de Exportação e integrará no sistema Cliente (WMS) por Estufagem ou Ovação.