Índice

maxLevel	5
outline	true
exclude	.*ndice
style	none

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:

Permitir cadastrar o pneu como aplicado;
Permitir a movimentação, o rodízio e o registro de calibração dos pneus, bem como sua visualização.
O Esquema Mod.2 é mais interativo, pois no modelo gráfico é visualmente mais funcional e mais completo.

...

.

...

Header

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

Variável	Descrição	Obrigatório	Exemplo
authorization	Ao executar a chamada do webservice, deverá ser configurado para Basic Auth utilizando usuário e senha do Protheus.	Sim	Basic Y0BuZ2kuY29tLmJyOjE
tenantId	Código da empresa + Código da Filial	Sim	T1,M RJ 01
x-erp-module	Representa o módulo do Protheus	Sim	GFR

Nota

title	Importante

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.
Para a api de abastecimento deve ser utilizado o módulo Gestão de Frotas (GFR)

Endpoints / Body

Endpoints

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

Método: /mntsrwsrest/apimntEsq/v1/requestEsqMntGrf

Tipo: GET

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

Bloco de código

language	js
firstline	1
title	Exemplo Header

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

Regras de Negócio

Para acessar essa funcionalidade serão necessários seguir os passos abaixo para incluir os itens necessários para seu funcionamento.

Deck of Cards

effectDuration	0.5
history	false
id	Schedule
effectType	fade

Card

id	1
label	Configurando 12.1.2310

Nota

title	Aviso

É imprescindível que o fonte MNTMWS esteja em seu RPO para o correto funcionamento.

Primeiro acesse o Configurador( SIGACFG ), Base de Dados > Dicionário > Base de dados. No canto esquerdo da tela, selecione a empresa, clique na opção dicionário de dados e então clique no ícone de busca( Image Removed ), busque pelo código TRX. Selecione a tabela TRX e clique em editar( Image Removed ), vá na parte de índices e clique em incluir( Image Removed) um novo índice.

CampoConteúdoCHAVETRX_PLACA+DTOS(TRX_DTINFR)+TRX_RHINFRNICKNAMEDESCRICAOPlaca Veicu. + Dta Infracao + Hra InfracaoDESCSPAPlaca Vehic. + Fch. Infrac. + Hora Infrac.DESCENGVhc.Plate + Viol. Date + Viol. TimeMOTRA PESQ.☑️VirtualizadoIX_VIRCUST3 - Padrão do Sistema

Image Removed

Clique em salvar, depois sair( Image Removed ). Vá na opção pastas( Image Removed ), selecione a opção parâmetros.

Deck of Cards

id	Configuração

Card

id	2
label	Não Integrado ao Financeiro

O parâmetro a ser adicionado é o MV_NGBROBO.

CampoConteúdoFilial( X6_FIL )Este conteúdo irá de acordo com a configuração do seu ambiente.Nome de Var.( X6_VAR )MV_NGBROBOTipo( X6_TIPO )1 - CaractereCont. Por.( X6_CONTEUD )Aqui você irá adicionar o token gerado pela Brobot.Descrição( X6_DESCRIC )Token para autenticar a integração de multas

Image Removed

Ao terminar o cadastro do parâmetro MV_NGBROBO conforme exemplo acima, vá na opção pastas( Image Removed ), selecione a opção Perguntas, clique em incluir ( Image Removed), adicione o grupo de perguntas conforme o exemplo abaixo, após finalizar o cadastro de perguntas clique em salvar( Image Removed ).

Grupo de Perguntas - MNTMWSOrdemPerguntaTipoTamanhoHelpObjetoPré Seleção(Combo)item 1 (Combo/Check/Expression)item 2 (Combo/Check)1De Data?Data8MemoEdit---2Até Data?Data8MemoEdit---3Criar Órgão Aut. Genérico?

Numérico

1

Memo

Combo

1

Não

Sim

Image Removed

Card

id	2
label	Integrado ao Financeiro

No caso do ambiente integrado ao financeiro, serão necessários o cadastro de dois parâmetros, o primeiro é o parâmetro MV_NGBROBO.

CampoConteúdoFilial( X6_FIL )Este conteúdo irá de acordo com a configuração do seu ambiente.Nome de Var.( X6_VAR )MV_NGBROBOTipo( X6_TIPO )1 - CaractereCont. Por.( X6_CONTEUD )Aqui você irá adicionar o token gerado pela Brobot.Descrição( X6_DESCRIC )Token para autenticar a integração de multas

Image Removed

O segundo parâmetro a ser cadastrado é o parâmetro MV_NGBROFI.

CampoConteúdoFilial( X6_FIL )Este conteúdo irá de acordo com a configuração do seu ambiente.Nome de Var.( X6_VAR )MV_NGBROFITipo( X6_TIPO )1 - CaractereCont. Por.( X6_CONTEUD )

Aqui você irá adicionar os códigos separados por ; ( ponto e virgula )

TRX_PREFIX
TRX_TIPO
TRX_NATURE
TRX_CONPAG

Exemplo: MNT;BOL;FIN2000028;003

Descrição( X6_DESCRIC )Campos para integração da multa com financeiro

Image Removed

Ao terminar o cadastro do parâmetro MV_NGBROFI conforme exemplo acima, vá na opção pastas( Image Removed ), selecione a opção Perguntas, clique em incluir ( Image Removed), adicione o grupo de perguntas conforme o exemplo abaixo, após finalizar o cadastro de perguntas clique em salvar( Image Removed ).

Grupo de Perguntas - MNTMWSF

Nota
Os tamanhos definido no grupo de perguntas deverão ser condizentes com o tamanho dos campos em sua base. No exemplo abaixo foram utilizados os tamanhos de 6 para Fornecedor e 2 para Loja, pois no ambiente de exemplo os campos de A2_FORNEC e A2_LOJA possuem esses tamanhos.

OrdemPerguntaTipoTamanhoValidaçãoHelpObjetoConsulta Padrão(Edit)Pré Seleção(Combo)item 1 (Combo/Check/Expression)item 2 (Combo/Check)1De Data?Data8-MemoEdit----2Até Data?Data8-MemoEdit----3Criar Órgão Aut. Genérico?

Numérico

1

-

Memo

Combo

-

1

Não

Sim

4Fornecedor?

Caracter

6

MV_PAR03 == 1 .Or. ( MV_PAR03 == 2 .And. NaoVazio() .And. ExistCpo( 'SA2', MV_PAR04 ) )

Memo

Edit

Fornecedor

-

5Loja?

Caracter

2

MV_PAR03 == 1 .Or. ( MV_PAR03 == 2 .And. NaoVazio() .And. ExistCpo( 'SA2', MV_PAR04 + MV_PAR05 ) )

Memo

Edit

-

6Cond. Pagamento?

Caracter

3

MV_PAR03 == 1 .Or. ( MV_PAR03 == 2 .And. NaoVazio() .And. ExistCpo( 'SE4', MV_PAR06 ) )

Memo

Edit

Cond. de Pagamento

-

Image Removed

Agora seu ambiente está pronto para utilizar desta melhoria! Siga os processos de Configuração Inicial e Agendamento para usufruir por completo!

Card

id	1
label	Configuração Inicial

Neste primeiro momento será necessário configurar o parâmetro MV_NGBROBO com o token disponibilizado pela Brobot. Esse token você pode encontrar na plataforma da Brobot em: definições > usuários > Selecione o usuário e procure pelo campo Token (API).

https://platform.brobot.com.br/definitions?tab=users

Image Removed

Após a inserção do Token, deverá ser validado se o ambiente possui o índice 9 da tabela TRX.

TabelaÍndiceDescriçãoTRX9TRX_PLACA + TRX_DTINFR + TRX_RHINFR

Caso seu ambiente não possua o parâmetro MV_NGMNTFI habilitado, a integração já estará funcional.

Card

id	1
label	Configuração com Financeiro

Com parâmetro MV_NGMNTFI habilitado, será necessário configurar o parâmetro MV_NGBROFI.

Exemplo:MNT;BOL;FIN2000028;003

CampoDescriçãoTRX_PREFIX Campo de identificação do conjunto de títulosTRX_TIPO Código do tipo do títuloTRX_NATURE Código da naturezaTRX_CONPAG Código da condição de pagamento

Ao finalizar essa configuração, a integração já estará funcional.

Card

id	1
label	Carga Inicial de Veiculos

Para inserir de forma automática os veículos já cadastrados no Protheus para o sistema da Brobot, vá em: Miscelânea > Gera Bens > Carga Inicial Brobot, selecione os veículos que deseja importar para Brobot e clique em Image Removed.

NºRegra1Caso o parâmetro MV_NGBROBO não esteja configurado corretamente não será possível realizar o processo de importação de veículos.2Somente serão apresentados veículos que possuírem em seu cadastro os campos de Placa, Renavam e UF preenchidos.3 Veículos que já estão cadastrados na Brobot serão apresentados como "Veículos não importados".

Card

id	1
label	Carga Inicial de Infrações

Agora o cadastro de infrações possui uma opção de "Carga Inicial" para infrações, isso tudo foi feito pensando na praticidade e agilidade, tornando assim o processo de inserção de multas mais simples. A opção de carga inicial de infrações está presente em outras ações da rotina de Infrações de Trânsito( MNTA770 ). Após executa-la, todas as multas contidas no Código de Transito Brasileiro até a data de 25/09/2024 serão importadas automaticamente.

Card

id	1
label	Agendamentos

Para que o processo de multas seja feito de forma totalmente automática, poderá ser configurado um Schedule para que execute o processo de busca de multa conforme a configuração desejada. Abaixo terá um breve exemplo de como configurar o Schedule de multas.

Através do Configurador (SIGACFG), busque pelo Schedule através do seguinte diretório:

Ambiente > Schedule > Schedule, selecione a opção "Novo"

Informe a rotina que irá executar o processo de busca de Multas.

Image Removed

Defina como será processo de execução.

Image Removed

Aqui você irá configurar de acordo com seu ambiente.

PadrãoCampoDescriçãoEmpresaEmpresa na qual o Schedule será executadoFilialFilial na qual o Schedule será executadoMóduloInformar Módulo Gestão de Frotas( 95 )UsuárioEm qual usuário será executado o ScheduleDescriçãoUma breve descrição do que se trata o Schedule Deck of Cards

id	Configuração

Card

id	2
label	Não Integrado ao Financeiro

Image Removed

Rotina Grupo de Perguntas MNTMWSCampoDescriçãoDe Data?Data inicial que serão realizadas as buscas das multasAté Data?Data final que serão realizadas as buscas das multasCriar Órgão Aut. Genérico?NãoSimNão cria órgão genéricoCria órgão genérico com código 000000 e descrição "Uso exclusivo Brobot"

Este parâmetro é utilizado em cenários onde o código do órgão autuador não é identificado automaticamente pela integração. Ele permite que o usuário registre as multas no sistema e, posteriormente, ajuste manualmente o órgão autuador.

Card

id	2
label	Integrado ao Financeiro

Image Removed

Rotina Grupo de Perguntas MNTMSFCampoDescriçãoDe Data?Data inicial que serão realizadas as buscas das multasAté Data?Data final que serão realizadas as buscas das multasCriar Órgão Aut. Genérico?NãoSimNão cria órgão genéricoCria órgão genérico com código 000000 e descrição "Uso exclusivo Brobot"

Este parâmetro é utilizado em cenários onde o código do órgão autuador não é identificado automaticamente pela integração. Ele permite que o usuário registre as multas no sistema e, posteriormente, ajuste manualmente o órgão autuador.

Fornecedor?Código do fornecedorLoja?Código da LojaCondição de Pagamento?Código da condição de pagamento

Pronto! Agora seu Schedule já está configurado!

Card

id	1
label	Identificando Problemas

Se houver alguma configuração incorreta, ao tentar executar qualquer processo relacionado à integração de Multas e Brobot, será gerado um arquivo no diretório especificado pelo RootPath configurado no seu appserver.ini. O arquivo será nomeado como MNTMWS + DATA + HORA.txt. A estrutura desse arquivo de texto seguirá o seguinte formato:

ItemDescriçãoUsuárioUsuário em que o processo foi executadoDataData da ocorrênciaHoraHora da ocorrênciaMensagemMensagem de erro

Regras de Negócio

...

effectDuration	0.5
history	false
id	Schedule
effectType	fade

Regras de negócio relacionados a integração de Multas Brobot.

...

Nº

...

Regra

...

Necessário possuir Órgão Autuador da multa cadastrado.

...

Necessário possuir veículo da multa cadastrado.

...

Multa será importada caso existe no sistema Brobot e as demais regras estejam de acordo.

Parâmetros

...

effectDuration	0.5
history	false
id	Schedule
effectType	fade

...

Token para autenticar a integração de multas.

...

Campos para integração da multa com financeiro. Para preenchimento deste parâmetro informe os seguintes campos:

TRX_PREFIX (Campo de identificação do conjunto de títulos)
TRX_TIPO (Código do tipo do título)
TRX_NATURE (Código da natureza)
TRX_CONPAG (Código da condição de pagamento)

Exemplo: MNT;BOL;FIN2000028;003

...

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)
2	TQ1_QTDPNE	Nú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

Exemplos

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

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

Image Added

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

Image Added

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

Informações Adicionais

Integração via API; https://www.totvs.com/blog/inovacoes/integracao-via-api/
API reference Totvs; https://api.totvs.com.br/;
Caso esteja ocorrendo algum problema, verificar a seção de dúvidas frequentes, no link http://tdn.totvs.com/x/J4HpDw.

Conteúdos Relacionados

Palavras-chave

Infração de Trânsito;
Multas;
Veículos;

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Objetivo

Introdução

Header

Endpoints / Body

Endpoints

Regras de Negócio

Regras de Negócio

Parâmetros

Exemplos

Informações Adicionais

Conteúdos Relacionados

Palavras-chave

Conteúdos Relacionados

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Objetivo

Introdução

Header

Endpoints / Body

Endpoints

Regras de Negócio

Regras de Negócio

Parâmetros

Exemplos

Informações Adicionais

Conteúdos Relacionados

Palavras-chave

Conteúdos Relacionados