Autores

Sobre este Documento

O objetivo deste documento é explicar como se dará o acesso a API desenvolvida pela eProfessionalTI, para fazer a integração dos movimentos de entrada e saída dos containers do Depósito da Brado-Cambé com a Reeferbras.

Descrição do projeto

Durante as definições do projeto de Integração Brado x Reeferbras, verificou-se a necessidade da Brado de informar alguns dados no momento da entrada e saída dos containers do sistema SGLOG para os sistemas Sister e Sisreefer da Reeferbras. A proposta deste projeto é a disponibilização de uma API para que a Brado tenha a possibilidade de informar esses dados de forma automática e em tempo real.

Características 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 da Brado. 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 deve acessar as seguintes URLs:

O método em questão é post e o seguinte JSON deve ser enviado:

DEPOT - CNPJ do Depósito da Brado

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 da Brado tenha sido feita com sucesso, o sistema cliente deverá usar o dado retornado (CHAVE) para acessar o método Entrada. O Acesso a este método dever ser feito através das seguintes URLs:

O método em questão é post e o seguinte JSON deve ser enviado:

Onde:

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 no Depósito

I - Requisição

Caso a autenticação do CNPJ da Brado tenha sido feita com sucesso, o sistema cliente deverá usar o dado retornado (CHAVE) para acessar o método Saida. O Acesso a este método dever ser feito através das seguintes URLs:

O método em questão é post e o seguinte JSON deve ser enviado:

Onde:

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.