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 (Veiculos)

Este guia prático orienta como realizar a integração com a API do PrologApp, especificamente para a consulta de informações dos veiculos.

Requisitos de Autenticação

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

  • 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)

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 Tipos de Veiculos

Agora, iremos consultar as informações dos tipos dos veiculos cadastrados no sistema. É possível uma busca segmentada por tipo e um texto especifico.

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

  • Método: GET

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

  • Parâmetros de Query: 

    obrigatório
    companyId : Buscar pelo código daempresa.

    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 tipos de veiculos inativos ou ativos - "TRUE" ou "FALSE".

    filtro
    textQuery : Buscar por algum tipo de informação referente ao tipo de veiculo.

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

Consultando os Modelos de Veiculos

Agora, iremos consultar as informações dos modelos dos veiculos cadastrados no sistema. É possível uma busca segmentada por modelos, marcas e um texto especifico.

(opcional)
É possível realizar uma busca mais especifica pelos filtros active, modelIds e makeIds.

  • Método: GET

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

  • Parâmetros de Query: 

    obrigatório
    companyId : 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
    active : Buscar por tipos de veiculos  ativos - "TRUE" ou "FALSE".

    filtro
    modelIds : Buscar pelo ID do modelo do veiculo. 

    filtro
    makeIds : Buscar pelo ID da marca do veiculo.

    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 as Marcas de Veiculos

Agora, iremos consultar as informações das marcas dos veiculos cadastrados no sistema. É possível uma busca segmentada por modelos, marcas e um texto especifico.

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

  • Método: GET

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

  • Parâmetros de Query: 

    obrigatório
    companyId : 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.

    obrigatório
    includeInactive : Incluir marcas de veiculos inativos ou ativos - "TRUE" ou "FALSE".

    obrigatório
    includeInactiveModels : Incluir modelos de veiculos inativos ou ativos - "TRUE" ou "FALSE".

    filtro
    active : Buscar por tipos de veiculos  ativos - "TRUE" ou "FALSE".

    filtro
    makeIds : Buscar pelo ID da marca do veiculo.

    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.