Informações do veículo por marca e modelo
Essa seção descreve como você pode obter as informações corretas dos veículos para serem enviadas na criação da proposta.
Para efetuar essa consulta você precisa primeiramente consultar uma lista de marcas de acordo com o ano do modelo do veículo, e após isso, consultar a lista de modelos, que inclui o valor do veículo, de acordo com a marca e ano do modelo do veículo.
Consultar Marcas
Para consulta da lista de marcas, basta usar o ano como parâmetro.
Requisição HTTP GET
Tipo da Requisição | URL | Exemplo |
---|---|---|
GET | {{url_base}}vehicles/brands | https://stg-api.creditas.io/b2b/vehicles/brands |
Request Params
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
year | integer | Sim | Ano que deseja consultar as marcas |
Exemplo de Request e Response
curl --location --request GET '{{url_base}}/vehicles/brands?year=2021' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'
{
"items": [
{
"name": "AGRALE"
},
{
"name": "AUDI"
},
{
"name": "BMW"
},
{
"name": "BYD"
}
],
"cursors": {}
}
Consultar Modelos
Para consultar a lista de modelos de veículos, você precisa informar como texto a marca escolhida dentre as recebidas no endpoint anterior e o ano do veículo.
O valor do veículo não é retornado na request.
Você deverá enviar o response desse endpoint no momento de criar a proposta. Deste modo, o campo value
será obtido através de chamadas internas em nossa API no momento da criação do lead.
Requisição HTTP GET
Tipo de Requisição | URL | Exemplo |
---|---|---|
GET | {{url_base}}/vehicles/models | https://stg-api.creditas.io/b2b/vehicles/models |
Request Params
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
brand | string | Sim | Marca do veículo que deseja realizar a consulta Ex: BMW |
year | integer | Sim | Ano do Modelo do veículo que deseja realizar a consulta Ex: 2021 |
Exemplo de Request e Response
curl --location --request GET '{{url_base}}/vehicles/models?brand=BMW&year=2021' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'
{
"items": [
{
"model": "320i",
"modelVersion": "SPORT GP NAC 2.0 16V TB ACTIVEFLEX",
"numberOfDoors": 4,
"fuelType": "Eta./Gas.",
"accessoryPackage": "Basico"
},
{
"model": "320i",
"modelVersion": "SPORT GP NAC 2.0 16V TB ACTIVEFLEX",
"numberOfDoors": 4,
"fuelType": "Eta./Gas.",
"accessoryPackage": "Completo"
},
{
"model": "320i",
"modelVersion": "M SPORT NAC 2.0 16V TB ACTIVEFLEX",
"numberOfDoors": 4,
"fuelType": "Eta./Gas.",
"accessoryPackage": "Basico"
},
{
"model": "320i",
"modelVersion": "M SPORT NAC 2.0 16V TB ACTIVEFLEX",
"numberOfDoors": 4,
"fuelType": "Eta./Gas.",
"accessoryPackage": "Completo"
}
],
"cursors": {}
}
Updated 5 months ago