Árvore de páginas

Í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á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,D MG 01
x-erp-moduleRepresenta o módulo do ProtheusSim

GFR

placaIndica qual a placa do veículo a ser pesquisadaSim

MNT001

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 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.

Exemplo Header
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:

    Body da Requisição
    {
       "Tires": [
          {
    		 "Code": "PNEU-50         ",
             "Location": "1",
             "calibration": {
                "gauged": 30,
                "carried_out": 40
             },
             "measurement": { 
                "first": 1.0,
                "second": 1.0,
                "third": 0.9
             }
          }
       ]
    }
    PropriedadeTipoRegra
    TiresJson

    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

    PropriedadeTipoRegraObrigatório
    CodeCaractereContém o código do Pneu para o qual será realizada a Calibragem ou Medição.Sim
    LocationCaractereDeve conter o código da localização do Pneu na estrutura do VeículoSim
    calibrationJson

    Deve conter as informações referentes a Calibragem do Pneu

    PropriedadeTipoRegra
    gaugedNuméricoCalibragem Realizada
    carried_outNuméricoCalibragem Atual
    Não
    measurementJson

    Deve conter as informações referentes a Medição de Sulco do Pneu

    PropriedadeTipoRegra
    firstnuméricoPrimeira Medição de Sulco
    secondnuméricoSegunda Medição de Sulco
    thirdnuméricoTerceira 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