Índice

Objetivo

O objetivo dessa API é enviar a estrutura dos registros da rotina Esquema Mod. 2 (MNTA221) para o software do parceiro Budini.

Introdução

O módulo de Gestão de Frotas possui o esquema padrão de pneus, que é fundamental para que possam ser utilizadas as funcionalidades de controle de pneus, principalmente para:

Header

Os parâmetros que deverão ser adicionados no header para possibilitar a utilização das api´s são:

VariávelDescriçãoObrigatórioExemplo
authorizationAo executar a chamada do webservice, deverá ser configurado para Basic Auth utilizando usuário e senha do Protheus.SimBasic Y0BuZ2kuY29tLmJyOjE
tenantIdCódigo da empresa + Código da FilialSimT1,M RJ 01
x-erp-moduleRepresenta o módulo do ProtheusSim

GFR

placaIndica qual a placa do veículo a ser pesquisadaNão

MNT001

datafimData de inclusão do veículoNão

20250101

horafimHora de inclusão do veículoNão

01:00

  • O valor inserido na variável tenantId não deverá possuir espaço entre a vírgula;
  • No exemplo apresentado na tabela acima, T1 corresponde a uma empresa e M RJ 01 a uma filial.
  • O campo x-erp-module deve ser preenchido apenas com a abreviação de três letras do módulo, sem o prefixo "SIGA", conforme indicado no exemplo.

Endpoints 

Aqui estão algumas informações referente ao processo de integração do SIGAGFR com a Budini.

Método: /rest/mntEsq/EsqMntGrf

Tipo: GET

Recebe as informações referentes aos Esquemas cadastrados na rotina Esquema Mod. 2 (MNTA221).

curl --request GET \
--url http://localhost:8080/rest/mntEsq/EsqMntGrf \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: GFR' \


Regras de Negócio

Regras de negócio relacionadas ao retorno das informações para a API

Nº

Campos

Regra


1


TQ1_TIPEIX

Tipo de Eixo:

1 = T - Livre (trailer)
2 = D - Tração (drive)
Outros = S - Direcional/Tracionador (steer)

2TQ1_QTDPNENúmero de Pneus na estrutura


3


TQ1_SUSPEN

Eixo suspenso :

1 = Y - Eixo Suspenso
2 = N - Eixo não Suspenso

4

-

Em caso de estruturas com mais de um eixo, o retorno será concatenado com um ponto ( . )
Ex: D2Y.D2N

5

-

Será exibido apenas um registro em caso de Esquema (TQ1_DESENH) e Tipo Modelo (TQ1_TIPMOD) semelhantes

6

axle

Informações referente ao Eixo, quando for realiza a busca por uma placa informada no header da requisição.


Exemplos

No exemplo correspondente à figura abaixo, o retorno da API será: T4N

T: Eixo Livre (TQ1_TIPEIX = 1)
4: Número de Pneus (TQ1_QTDPNE = 4)
N: Eixo não Suspenso (TQ1_SUSPEN = 2)

                                                                                                                                                                                                                                                                                                  

No exemplo correspondente à figura abaixo, onde a estrutura possui dois eixos e um deles é suspenso, o retorno da API será: D2Y.D2N

D: Tração (TQ1_TIPEIX = 2)
2: Número de Pneus (TQ1_QTDPNE = 2)
Y: Eixo Suspenso (TQ1_SUSPEN = 1)

D: Tração (TQ1_TIPEIX = 2)
2: Número de Pneus (TQ1_QTDPNE = 2)
N: Eixo não Suspenso (TQ1_SUSPEN = 2)


Estrutura de veículo

Para realizar a busca da estrutura de um veículo específico, deverá ser informada a placa do veículo e sempre buscar com base na data/hora atual.
Com base nessas informações, a busca da estrutura do Veículo é realizada conforme informações das tabelas TQ1 (Itens do Desenho do Rodado), STZ (Complemento Bem - Pneus) e STZ (Movimentação de Bens).


No exemplo abaixo, possuímos um Esquema Padrão com quatro pneus e posteriormente foi realizada a aplicação de um Pneu na posição ESQ01



Ao realizar a consulta da placa do veículo informado via API, o retorno será apenas da estrutura desse veículo, conforme abaixo:
{"structure":"T4N","axle":[["PNEU 002.ESQ01",".ESQ02",".ESQ03",".ESQ04"]]}

Informações Adicionais

Conteúdos Relacionados