Í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:
- 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 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 |
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.
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 | TQ1_QTDPNE | Número de Pneus na estrutura |
3 | TQ1_SUSPEN | Eixo suspenso : 1 = Y - Eixo Suspenso |
4 | - | Em caso de estruturas com mais de um eixo, o retorno será concatenado com um ponto ( . ) |
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
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)
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.