/vehicles/models
API para recuperar informação do ID do veículo que será utilizado na cotação

Objetivo

Esta API tem o objetivo de retornar o ID do modelo do veículo HDI que será utilizado na cotação de AUTO.

Contrato de Serviço - Swagger
Download Swagger
Collection Test Postman
Download Collection Test
Dados Básicos

Nome do Serviço

/vehicles/models

Descrição Resumida

Prover informações do veículo para retornar o ID do modelo para ser realizada a cotação Auto

URL

Base Path:
openapi.hdi.com.br/marketplace/offer/v1

URI:
/vehicles/models

Status

Ativo

Versão

1.0

Diagrama
Exemplo de Payload
key=AIzaSyCS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
fipe=005306-6
description=GOL
Content-Type=application/json
X-Company-Id=01
X-Application-Id=01
X-User-Id=01
Authorization=Bearer eyJraWQiOiJiZDc2MzhjYzg4OTU2ZmNjZGFhMGRlYWQ2NDk5M2E1NjQ0ZTcwMTVkIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJoZGktY29ycG9yYXRlLWF1dGhAaW5zLWNyb3NzLXNlY3VyaXR5LWF1dGgtaW50Zy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsImF1ZCI6ImFwaS5oZGkuY29tLmJyIiwiYXBwbGljYXRpb24iOltudWxsXSwicm9sZXMiOlsiUm9sZTEiLCJSb2xlMiIsIlJvbGVOIl0sImlzcyI6ImhkaS1jb3Jwb3JhdGUtYXV0aEBpbnMtY3Jvc3Mtc2VjdXJpdHktYXV0aC1pbnRnLmlhbS5nc2VydmljZWFjY291bnQuY29tIiwiZXhwIjoxNTcyNDc4NDY4LCJpYXQiOjE1NzI0NzQ4NjgsInVzZXIiOlsiYXBpLWlucy1pbnRlZ3JhdGlvbi1pbnRlcm5hbC1hY2Nlc3MiXSwid2ViQ2xpZW50IjpbbnVsbF19.N0KeFZzNZiUToV0-Y3hA15PYaYzAUq4xSjbErA97FUhp3Mqs1Yg2AByIOhcqWG4qIuEqvSuf1dIH0QdIToVySP4db9fGEELqu48SF1yCwk2fuaxGLmRtgNDjoJRPwkrxFDUSR7MMsnxn9pV2_sevaWJCyF7QKdGMG0zgZVQbb25S7IrOD3CF97fN9PN5yhsj9f3C8_WDqbDRsvVUdMItmmsbQI98iWM4xQ7O93s1TQCcd84ZQhOdBfYw_yY6jz-hA-tYin3vS33DIcAAR-HNnljdV_9XmWQ5WXd07VjCI8Ynntlrb3vyYjgbkl15VMvfsm0p2ZXgm5jLKFdw8w5nyg
[
    {
        "plateCode": null,
        "model": {
            "id": 15239,
            "description": "FOX",
            "fipeCode": "005306-6",
            "yearsModel": [
                {
                    "year": "2009"
                },
                {
                    "year": "2010"
                },
                {
                    "year": "2011"
                },
                {
                    "year": "2012"
                },
                {
                    "year": "2013"
                }
            ],
            "seatingCapacity": 5,
            "insurable": true,
            "fuelType": {
                "code": 5,
                "description": null
            },
            "category": {
                "code": 10,
                "description": "PASSEIO - NACIONAL"
            },
            "brand": {
                "id": 110,
                "description": "VOLKSWAGEN"
            }
        },
        "chassisCode": null,
        "yearsMade": [
            {
                "year": "2009"
            },
            {
                "year": "2010"
            },
            {
                "year": "2011"
            },
            {
                "year": "2012"
            },
            {
                "year": "2013"
            }
        ]
    },
    {
        "plateCode": null,
        "model": {
            "id": 15819,
            "description": "FOX",
            "fipeCode": "005306-6",
            "yearsModel": [
                {
                    "year": "2009"
                },
                {
                    "year": "2010"
                },
                {
                    "year": "2011"
                },
                {
                    "year": "2012"
                },
                {
                    "year": "2013"
                }
            ],
            "seatingCapacity": 5,
            "insurable": true,
            "fuelType": {
                "code": 5,
                "description": null
            },
            "category": {
                "code": 10,
                "description": "PASSEIO - NACIONAL"
            },
            "brand": {
                "id": 110,
                "description": "VOLKSWAGEN"
            }
        },
        "chassisCode": null,
        "yearsMade": [
            {
                "year": "2009"
            },
            {
                "year": "2010"
            },
            {
                "year": "2011"
            },
            {
                "year": "2012"
            },
            {
                "year": "2013"
            }
        ]
    }
]
Parâmetros e Detalhes do Request
REQUEST
  • Header
    • Content-Type
      Tipo: String
      Obrigatório: Sim
      Descrição: Tipo do conteúdo a ser trafegado no protocolo http
      -- Saiba Mais
      [+]
      Este conteúdo pode ser: Application/Json e em alguns casos já temos Application/PDF
    • X-Company-id
      Tipo: String
      Obrigatório: Sim
      Descrição: Código da empresa
      -- Saiba Mais
      [+]
      Deverá ser informado um número para a empresa, que posteriormente servirá para rastreio do consumo da API, por exemplo, este campo no recálculo, na proposta e nas consultas de cálculo e emissão deverão ser o mesmo da oferta inicial
    • x-Application-id
      Tipo: String
      Obrigatório: Sim
      Descrição: Código da aplicação
      -- Saiba Mais
      [+]
      Código recebido pela HDI para identificação da aplicação que está consumindo a API, se a API for utilizada por mais do que uma aplicação, informar a HDI para gerar um outro código, desta forma garantimos a unicidade das transações e conseguimos ter clareza nas produtividades de cada aplicação
    • X-User-Id
      Tipo: String
      Obrigatório: Sim
      Descrição: Código do Usuário
      -- Saiba Mais
      [+]
      Deverá ser informado o CPF do usuário vendedor no caso de seguros. Outros segmentos poderão ter o código do usuário a autenticar no sistema diferente do CPF
    • Authorization
      Tipo: String
      Obrigatório: Sim
      Descrição: Token de Autorização
      -- Saiba Mais
      [+]
      Ex: Deverá ser informado o code da API de Token, que deverá ser renovada após 1 hora
  • Param
    • key
      Tipo: String
      Obrigatório: Sim
      Descrição: chave de acesso única por player.
      -- Saiba Mais
      [+]
      Esta chave é intransferível e garante a autorização para consumir as funcionalidades da HDI Seguros, ou seja, em todos as chamadas independente da API deverá ser trafegada esta chave nos Params.
      Para obter acesso a chave é necessário passar por um processo de autorização junto a área de parcerias da HDI Seguros. O canal para solicitar acesso é através do e-mail: [email protected]
    • fipe
      Tipo: String
      Obrigatório: Não
      Descrição: Código FIPE
      -- Saiba Mais
      [+]
      Deverá ser informado o código da FIPE que deverá conter 6 números e o dígito que deverá ser separado por traço, conforme exemplo: 001111-6
      Se informado a fipe com o description na mesma requisição, a informação que será considerada será da FIPE
    • description
      Tipo: String
      Obrigatório: Não
      Descrição: Descrição do Modelo
      -- Saiba Mais
      [+]
      Neste campo poderá ser informado a marca e/ou modelo do veículo, sendo que a descrição poderá ser aproximada para retorno da lista de veículos
      Apesar deste campo ser opcional, para consulta de veículos obrigatoriamente precisa ser informado ao menos um dos parâmetros, fipe, chassi ou description
Parâmetros e Detalhes do Response
RESPONSE
  • Header
  • Body
    • []
      • plateCode
        Tipo: String
        Obrigatório: Sim
        Descrição: Placa do Veículo
        -- Saiba Mais
        [+]
        Até a publicação deste documento, este campo sempre retornará vazio, no entanto, logo mais será possível fazer filtro por placa, trazendo a informação mais precisa do veículo do cliente
      • chassisCode
        Tipo: String
        Obrigatório: Sim
        Descrição: Chassi do Veículo´
        -- Saiba Mais
        [+]
        Até a publicação deste documento, este campo sempre retornará vazio, no entanto, logo mais será possível fazer filtro por chassi, trazendo a informação mais precisa do veículo do cliente
      • model
        • id
          Tipo: Integer
          Obrigatório: Sim
          Descrição: id do modelo HDI
          -- Saiba Mais
          [+]
          Retornará o id do veículo que poderá ser utilizado na oferta e no recálculo. EX: 15239 para FOX

          O produto HDI Auto Perfil aceita veículo de até R$ 350.000,00, já os produtos HDI FIT e HDI Flex aceita veículos de até R$ 80.000,00, ou seja, nem todos os veículos no retorno da consulta serão comercializados.
        • description
          Tipo: String
          Obrigatório: Sim
          Descrição: Descrição do Modelo
          -- Saiba Mais
          [+]
          Retornará à descrição do veículo, por exemplo, FOX
        • fipeCode
          Tipo: String
          Obrigatório: Sim
          Descrição: Código FIPE
          -- Saiba Mais
          [+]
          Código do veículo conforme tabela FIPE
        • yearsModel[]
          • year
            Tipo: String
            Obrigatório: Sim
            Descrição: Ano do Modelo
            -- Saiba Mais
            [+]
            Será retornado o ano modelo do veículo que deverá ser utilizado na entrada da oferta e recálculo. EX: {2009}
        • fuelType
          • code
            Tipo: String
            Obrigatório: Sim
            Descrição: Código do combustivel
            -- Saiba Mais
            [+]
            Será retornado o código do combustível, que deverá ser utilizada na oferta e recálculo. EX: 1 , 2 , 3 , 4 , 5 , 7 , 8 , 9
          • description
            Tipo: String
            Obrigatório: Sim
            Descrição: Descrição do combustivel
            -- Saiba Mais
            [+]
            Será retornado à descrição do combustível, por exemplo, Gasolina, Álcool, Diesel, Eletricidade, Bi-Combustível, Gas. (Alcool) . Gás, Tetraful, 9 Outros
        • category
          • code
            Tipo: String
            Obrigatório: Sim
            Descrição: Código da categoria do modelo do veículo
            -- Saiba Mais
            [+]
            Será retornado o código da categoria do veículo, que deverá ser utilizado para filtros nas coberturas e questionário . Ex: 10
          • description
            Tipo: String
            Obrigatório: Sim
            Descrição: Descrição da categoria do modelo do veículo
            -- Saiba Mais
            [+]
            Será retornado à descrição correspondente ao código da categoria. Ex: PASSEIO - NACIONAL
        • brand
          • id
            Tipo: String
            Obrigatório: Sim
            Descrição: Código da marca do modelo do veículo
            -- Saiba Mais
            [+]
            Será retornado o ID da marca do veículo. Ex: 110
          • description
            Tipo: String
            Obrigatório: Sim
            Descrição: Descrição da marca do modelo do veículo
            -- Saiba Mais
            [+]
            Será retornado à descrição da marca do veículo. Ex: VOLKSWAGEN
      • yearsMade[]
        • year
          Tipo: String
          Obrigatório: Sim
          Descrição: Ano de fabricação do modelo do veículo
          -- Saiba Mais
          [+]
          Será retornado o ano fabricação do veículo que deverá ser utilizado na entrada da oferta e recálculo. Ex: 2009

.

Informações de ambientes
Histórico de versões

Autor

Área ou Setor

Versão

Descrição da versão

OpenInsurance

Integração

V1.0

Versão Inicial

Language
Response
Click Try It! to start a request and see the response here!