Pular para o conteúdo
Português - Brasil
Portal do cliente
Ir para prologapp.com
  • Não há sugestões porque o campo de pesquisa está em branco.

Integração com a API PrologApp: Manual de Consumo (Pneus)

Este guia prático orienta como realizar a integração com a API do PrologApp, especificamente para o módulo de pneus, detalhando os requisitos de autenticação e a consulta inicial.

Requisitos de Autenticação

Para qualquer tipo de consulta na API, é obrigatório possuir um Token.

  • O token é único por empresa, independentemente da quantidade de unidades da operação.

Obtendo Credenciais de Acesso

Antes de iniciar, você deve obter dois dados fundamentais com o suporte da Prolog:

  • Seu Token de acesso.

  • O companyId (ID da empresa), necessário para filtrar as consultas.

Ferramenta de consulta da API

Neste exemplo, usamos o Postman para as consultas via API, mas sinta-se à vontade para usar a ferramenta que desejar.

Clique aqui para acessar o site oficial do Postman.
Clique aqui para acessar o tutorial de como utilizar o Postman.
Clique aqui para baixar todas as consultas do postman.

 

Consultando os Códigos das Unidades

Para iniciar as operações, você deve identificar os códigos das unidades da sua empresa.

  • Método: GET

  • Endpoint: https://prologapp.com/prolog/api/v3/branch-offices

  • Parâmetros de Query: 

    obrigatório
    companyId : Buscar pelo código único da empresa.

    filtro
    companyGroupId : Buscar pelo código da região/grupo da empresa.

    filtro
    isActive : Buscar apenas pelas unidades com status ativa ou desativada - "TRUE" ou "FALSE".

     

     

O token deve ser inserido no Header de cada consulta sob o parâmetro/Key x-prolog-api-token.

Consultando os Veículos da Unidade

Após obter o branchOfficeId (ID da unidade) na etapa anterior, você está pronto para consultar as placas vinculadas a ela. Sem o código da unidade, não é possível filtrar os veículos corretamente no sistema.

branchOfficesId ele é obtido  na consulta anterior Consultando os Códigos das Unidades, no campo ID.

(opcional)
Para obter as informações dos filtros modelId e typeId será necessário novas consultas, clique aqui para acessar o manual de consultas. 

  • Método: GET

  • Endpoint: https://prologapp.com/prolog/api/v3/vehicles

  • Parâmetros de Query: 

    obrigatório
    branchOfficesId : Buscar pelo código da unidade.

    obrigatório
    includeInactive : Incluir por veículos inativos - "TRUE" ou "FALSE".

    obrigatório
    pageSize : Quantidade de itens na página - min = 1, max = 100.

    obrigatório
    pageNumber : Qual a página que deseja visualizar - padrão = 0.

    filtro
    active : Buscar por veículos inativos ou ativos - "TRUE" ou "FALSE".

    filtro
    modelId : Buscar pelo código do modelo do veículo.

    filtro
    typeId : Buscar pelo código do tipo do veículo.

    filtro
    textQuery : Buscar por algum tipo de informação referente ao veículo.

 

O token deve ser inserido no Header de cada consulta sob o parâmetro/Key x-prolog-api-token.

 

Consultando os Pneus da Unidade

Agora, iremos consultar os pneus cadastrados na unidade, informações detalhadas dos pneus e até a relação sobre o uso do pneu.

(opcional)
É possível realizar uma busca mais especifica pelos filtros serialNumberTextQuery e textQuery.

  • Método: GET

  • Endpoint: https://prologapp.com/prolog/api/v3/tires

  • Parâmetros de Query: 

    obrigatório
    branchOfficesId : Buscar pelo código da unidade.

    obrigatório
    pageSize : Quantidade de itens na página - min = 1, max = 100.

    obrigatório
    pageNumber : Qual a página que deseja visualizar - padrão = 0.

    filtro
    tireStatuses : Buscar por status do pneu "INVENTORY","ANALYSIS","INSTALLED" e "DISPOSAL".

    filtro
    textQuery : Buscar por palavra especifica.

    filtro
    minimalTextQuery : Buscar por campo que contenha o texto.

    filtro
    serialNumberTextQuery : Buscar pela marcação a fogo do pneu.

    filtro
    makeIds : Buscar pelo ID da Marca do pneu.

    filtro
    modelIds : Buscar pelo ID do Modelo do pneu.

    filtro
    treadMakeId : Buscar pelo ID da Marca do recape.

    filtro
    treadModelId : Buscar pelo id do Modelo do recape.

    filtro
    currentLifeCycles : Buscarpela vida atual do pneu.

    filtro
    dimensionsIds : Buscar pelo ID da Dimenssão do pneu.

     

 

O token deve ser inserido no Header de cada consulta sob o parâmetro/Key x-prolog-api-token.

Consultando as Movimentações dos Pneus por Unidade

Agora, iremos consultar as movimentações realizadas no sistema, sejam por período ou por destinos, como, descarte (disposal).

(opcional)
É possível realizar uma busca mais especifica pelos filtros destinations, vehicleId e tireId.

  • Método: GET

  • Endpoint: https://prologapp.com/prolog/api/v3/tire-relocations

  • Parâmetros de Query: 

    obrigatório
    branchOfficesId : Buscar pelo código da unidade.

    obrigatório
    startDate : Buscar pela data inicial - YYYY-MM-DD.

    obrigatório
    endDate : Buscar pela data final - YYYY-MM-DD.

    obrigatório
    pageSize : Quantidade de itens na página - min = 1, max = 100.

    obrigatório
    pageNumber : Qual a página que deseja visualizar - padrão = 0

    filtro
    destinations : Buscar pelos destinos de status "INVENTORY","ANALYSIS","INSTALLED" e "DISPOSAL"

    filtro
    userId : Buscar pelo ID do colaborador.

    filtro
    vehicleId : Buscar pelo ID do veiculo.

    filtro
    tireId : Buscar pelo ID do pneu.

 

O token deve ser inserido no Header de cada consulta sob o parâmetro/Key x-prolog-api-token.

Consultando as Aferições dos Pneus realizadas nos veiculos por Unidade

Agora, iremos consultar as aferições/inspeções dos pneus, que foram realizadas com o aferidor da Prolog, vamos buscar por um período, ou seja, data inicial e uma data final.

(opcional)
É possível realizar uma busca mais especifica pelos filtros vehicleId e textQuery.

  • Método: GET

  • Endpoint: https://prologapp.com/prolog/api/v3/tire-inspections/vehicles

  • Parâmetros de Query: 

    obrigatório
    branchOfficesId : Buscar pelo código da unidade.

    obrigatório
    startDate : Buscar pela data inicial - YYYY-MM-DD.

    obrigatório
    endDate : Buscar pela data final - YYYY-MM-DD.

    obrigatório
    includeMeasures: Incluir medições - "TRUE" ou "FALSE".

    obrigatório
    pageSize: Quantidade de itens na página - min = 1, max = 100.

    obrigatório
    pageNumber: Qual a página que deseja visualizar - padrão = 0.

    filtro
    vehicleTypeId : Buscar pelo ID do tipo do veículo.

    filtro
    vehicleId : Buscar pelo ID do veículo.

    filtro
    textQuery : Buscar por palavra especifica.


     

     

 

O token deve ser inserido no Header de cada consulta sob o parâmetro/Key x-prolog-api-token.

Consultando os Serviços de Pneus

Agora, iremos consultar os serviços de pneus gerados mediante ao processo de aferição/inspeção nos pneus.

(opcional)
É possível realizar uma busca mais especifica pelos filtros tireIssueStatus e tireId.

  • Método: GET

  • Endpoint: https://prologapp.com/prolog/api/v3/tire-issues

  • Parâmetros de Query: 

    obrigatório
    branchOfficesId : Buscar pelo código da unidade.

    obrigatório
    pageSize : Quantidade de itens na página - min = 1, max = 100.

    obrigatório
    pageNumber : Qual a página que deseja visualizar - padrão = 0.

    filtro
    tireIssueStatus : Buscar pelo status do serviço do pneu - "OPEN" e "RESOLVED".

    filtro
    vehicleId : Buscar pelo ID do veículo.

    filtro
    tireId :  Buscar pelo ID do pneu.

O token deve ser inserido no Header de cada consulta sob o parâmetro/Key x-prolog-api-token.