Índice
Objetivo
O objetivo da API é receber e criar a Calibragem ou Medição de Sulco realizada pelo software do parceiro Budini.
Introdução
A API permite realizar a Calibragem ou Medição de Sulco de um Pneu em estrutura via requisição.
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,D MG 01 |
| x-erp-module | Representa o módulo do Protheus | Sim | GFR |
| placa | Indica qual a placa do veículo a ser pesquisada | Sim | MNT001 |
- 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 D MG 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
Método: rest/mntCalibragem
Tipo: POST
Recebe as informações referentes a Calibragem e/ou Medição de Sulco e realiza a gravação (MNTA995).
É possível enviar na requisição apenas uma calibragem ou apenas uma medição porém ao menos um dos dois é obrigatório. Também não é necessário que todos os pneus da estrutura do Bem sejam enviados para realizar o processo.
curl --request POST \
--url http://localhost:8080/rest/mntCalibragem
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: GFR' \ |
Body da requisição
Estrutura da Requisição Exemplo: {
"Tires": [
{
"Code": "PNEU-50 ",
"Location": "1",
"calibration": {
"gauged": 30,
"carried_out": 40
},
"measurement": {
"first": 1.0,
"second": 1.0,
"third": 0.9
}
}
]
} |
| Propriedade | Tipo | Regra |
|---|
| Tires | Json | Tires é o agrupador principal da requisição, dentro dele devem ser enviados os Arrays referentes a cada Pneu individualmente contendo as informações relacionadas a Calibragem e Medição de Sulco | Propriedade | Tipo | Regra | Obrigatório |
|---|
| Code | Caractere | Contém o código do Pneu para o qual será realizada a Calibragem ou Medição. | Sim | | Location | Caractere | Deve conter o código da localização do Pneu na estrutura do Veículo | Sim | | calibration | Json | Deve conter as informações referentes a Calibragem do Pneu | Propriedade | Tipo | Regra |
|---|
| gauged | Numérico | Calibragem Realizada | | carried_out | Numérico | Calibragem Atual |
| Não | | measurement | Json | Deve conter as informações referentes a Medição de Sulco do Pneu | Propriedade | Tipo | Regra |
|---|
| first | numérico | Primeira Medição de Sulco | | second | numérico | Segunda Medição de Sulco | | third | numérico | Terceira Medição de Sulco |
| Não |
|
|
Exemplos
No exemplo a seguir vamos realizar a Calibragem e Medição de Sulco de dois Pneus via API.
Informações Adicionais
Conteúdos Relacionados