API Integração Fretamento

1. Informações Gerais

2. Cadasto de código fixo 

Para conseguirmos fazer um tipo de relacionamento (DE/PARA) de funcionários, iremos utilizar o cadastro de código fixo do módulo de folha de pagamento.

Passo 1:  Abrir o módulo de Folha de pagamento e acessar o menu Cadastros > Funcionário > Código fixo.

Passo 2: Cadastrar um código tipo de código fixo para ser utilizado nos motoristas do Fretamento.

Poderá definir para esse tipo de código fixo que ele poderá ser 'Valor', 'Caracter', 'Data' ou 'Lógico', porém, para o fretamento deve criar com o Tipo definido como Caracter.

2. Associação de código fixo à funcionários

Deve associar a cada motorista que será utilizado no Fretamento, um código fixo, que será o código de referência dele no sistema de monitoramento que será utilizado.

Esse código fixo será utilizado para podemos saber qual funcionário do Globus iremos lançar uma Ordem de serviço (extra), quando vier do monitoramento sem ter a sua origem pelo Fretamento.

Quando a origem for do Fretamento, conseguiremos saber sem utilizar o código fixo, pois já iremos enviar o funcionário para o monitoramento anteriormente.

Passo 1: Abrir o módulo de Folha de pagamento e acessar o menu Cadastros > Funcionários > Associa códigos fixos.

Passo 2: Informar Empresa, Filial, Informar o funcionário, Selecionar o código fixo que foi criado na tela anterior para os motoristas de Fretamento, Clicar em 'Autoriza', Informar o código do funcionário (no monitoramento) no campo que irá abrir logo em frente do botão Autoriza e em seguida dar TAB.

Com isso, ficará associado do lado direito, o código fixo e o código de relacionamento do funcionário no monitoramento, conforme exemplo abaixo:

3. Parâmetros do Fretamento

Nos Parâmetros do Fretamento+, na aba Integração com monitoramento, criamos um campo para definir qual Código fixo iremos utilizar como referência de relacionamento no monitoramento. 

Então devemos associar o código fixo que foi criado, neste campo.

Criamos também, um campo com de Arquitetura, onde poderemos selecionar entre SOAP e REST, dento que este padrão que está sendo demonstrado neste documento é para arquitetura REST.

Arquitetura SOAP não teve alteração e os passos descritos aqui não se aplicam para ele.

Foram criados campos para Autenticação API Globus e Autenticação API Parceiro. Estes campos serão utilizados para validação e geração de token para o parceiro ter acesso a nossa API e da mesma forma termos acesso à API deles.

Passo 1: Abrir o módulo de Fretamento e acessar o menu Cadastros > Parâmetros > Empresa.

Passo 2: Acessar a aba Integração com monitoramento, definir o Código fixo que foi criado na folha, definir a arquitetura REST, informar os endereços de produção e homologação do parceiro e Informar o Usuário e Senha de Autenticação API Globus e API Parceiro.

4. APIs

Para que o parceiro consiga ter acesso às APIs que criamos, ele precisa de um token válido, e para isso, deverá fazer uma requisição, informando grant_type, username e password na API Token do tipo POST.

Vale lembrar, que para o parâmetro grant_tipe, sempre será informado password.

Nos parâmetros usermane e password, informar os dados definidos nos parâmetros do Fretamento, nos campos de Autenticação API Globus.

Se a validação dos parâmetros do OK, será retornado um token do tipo bearer e este será utilizado nas demais APIs que serão mostradas mais abaixo.

OBS.: Cada token gerado terá validade de 24h, depois disso deverá fazer nova requisição e será gerado outro token.

Exemplo:

Na API Linha/Consulta do tipo GET, é possível verificar todas as linhas que foram incluídas ou alteradas no Globus a partir de uma determinada data.

Nesta API será necessário passar uma Data e a Authorization (token do tipo bearer).

Exemplo:

Na API Monitoramento/Servicos/Baixar do tipo PUT, fazemos a baixa das Ordem de Serviço que foram enviadas para o monitoramento pelo Globus.

Nela deverá ser informado Json com os serviços que serão baixados no Globus pelo retorno do monitoramento e a Authorization (token do tipo bearer).

As informações que vem neste Json, quase que por completo, foram enviadas para o monitoramento pelo Globus, porém, o monitoramento poderá informar diferentes registros nos campos de Velocímetro de Pegada, Início, Fim e Largada e também nos campos de Horários de Pegada, Início, Fim e Largada e Quantidade de Passageiros.

Exemplo:

Já na API Monitoramento/Servicos/Incluir do tipo POST, servirá para incluir serviços extras, estes serviços não irão ser enviados do Globus para o monitoramento, apenas serão gerados no monitoramento e posteriormente serem enviados ao Globus.

Todos os campos do Json devem ser gerados pelo monitoramento, com exceção dos campos numero e item, pois o código de OS será gerado assim que a informação entrar no Globus. Deve ser enviado também o campo Authentication (token do tipo bearer).

Neste Json, o campo motorista_id será a referência que foi associada no código fixo, para que possamos encontrar qual funcionário do Globus tem este código fixo.

Exemplos: