MKSPEC LA

Documentação de Integração MKSPEC – Banco de Dados dos Veículos do Mercado Brasileiro

Introdução

Nosso API é REST (Representational State Transfer, é um estilo de arquitetura de software para sistemas hipermídia distribuídos, como a WWW), o que significa que cada URL proporciona informação sobre diferentes entidades (Itens/Veículos).
Todas as respostas retornadas estão codificadas através do JSON (JavaScript Object Notation) Para mais detalhes sobre a arquitetura da API, consulte Considerações sobre a Arquitetura, abaixo.
Todos os nossos acessos são feitos por meio individual e privado, através de um usuário e senha para acessar as informações, sendo vocês os únicos responsáveis pela forma de uso e acesso ao sistema / banco de dados (Observação: conforme consta em contrato, as informações / banco de dados / API, são de propriedade da MKSPEC Auto Market Support SS não podendo ser comercializadas ou divulgadas à terceiros)

Como utilizar a API

Autenticação Básica

A autenticação de acesso básico é um método de autenticação simples integrado ao protocolo HTTP na qual um usuário fornece um nome de usuário e senha ao fazer uma solicitação de acesso - essa solicitação contém um campo de cabeçalho na forma de Autorização: Basic , em que as credenciais são a codificação Base64 de ID e senha.
Por exemplo, para autorizar como mkspec/adminpass o usuário enviaria:

Authorization: Basic bWtzcGVjOmFkbWlucGFzcw==

Obter veículos

Utilizado para se obter as informações de todos os veículos que a MKSPEC possui em seu banco de dados.

Parâmetros

marca: é opcional e serve para filtrar por uma marca específica.
versaoCompleta: é opcional e serve para filtrar por uma versao específica.
atualizacao: é opcional e serve para filtrar desde uma data de atualização até hoje.

Exemplo desse comando utilizando cURL:

curl --location --request GET 'https://api.mkspec.la/veiculos(?marca=BMW)' --header 'Authorization: Basic base64_encode(user:pass)'

[
  {
      "codigo_mkspec_anomodelo": 202240,
      "codigo_mkspec_versao": 81100,
      "marca": "BMW",
      "modelo": "118i",
      "versao": "1.5 M SPORT Aut. 5-P Gasolina",
      "versaoCompleta": "BMW 118i 1.5 M SPORT Aut. 5-P Gasolina",
      "cilindrada_L": "1.5",
      "ano_modelo": "2023",
      "fipe_id": "",
      "renavam": [],
      "data_atualizacao": "2022-08-29T14:11:34",
      "equipamentos_serie": [
            121,
            141,
            161,
            ...
      ],
      "dados_tecnicos": [
        {
            "combustivel_id": 11,
            "dado_tecnico_id": 251,
            "valor": "22,4"
        },
        ...
      ],
      "precos_publicos_sugeridos": [
        {
            "preco_id": 1138540,
            "data_tabela": "2022-06-01T00:00:00",
            "ano_fabricacao": "2022",
            "preco": 315950,
            "opcionais": [
                {
                    "opcional_id": 6052120,
                    "nome_completo": "PM (PINTURA METu00c1LICA)",
                    "codigo_descricao": "PM",
                    "descricao": "PINTURA METu00c1LICA",
                    "preco": 1700,
                    "vinculo": null,
                    "incompatibilidades": null,
                    "equipamentos": [
                        1461
                    ]
                }
            ]
        },
        ...
      ],
      "depreciacoes": [
        {
            "qtd_ano": 1,
            "valor": 0.1118
        },
        ...
      ]
  },
  ...
]

Obter marcas

Utilizado para se obter as informações de todas as marcas dos heículos que a MKSPEC possui em seu banco de dados.

Exemplo desse comando utilizando cURL:

curl --location --request GET 'https://api.mkspec.la/marcas' --header 'Authorization: Basic base64_encode(user:pass)'

[
    {
        "id": "AUDI",
        "nome": "AUDI"
    },
    {
        "id": "BMW",
        "nome": "BMW"
    },
    ...
]

Obter modelos

Utilizado para se obter as informações de todos os modelos dos heículos que a MKSPEC possui em seu banco de dados.

Exemplo desse comando utilizando cURL:

Parâmetros

marca: é opcional e serve para filtrar por uma marca específica.

curl --location --request GET 'https://api.mkspec.la/modelos(?marca=AUDI)' --header 'Authorization: Basic base64_encode(user:pass)'

[
    {
        "id": "A3 SEDAN",
        "nome": "A3 SEDAN",
        "id_marca": "AUDI",
        "nome_marca": "AUDI"
    },
    ...
]

Obter versoes

Utilizado para se obter as informações de todas as versoes dos heículos que a MKSPEC possui em seu banco de dados.

Exemplo desse comando utilizando cURL:

Parâmetros

marca: é opcional e serve para filtrar por uma marca específica.
modelo: é opcional e serve para filtrar por um modelo específico.

curl --location --request GET 'https://api.mkspec.la/versoes(?marca=AUDI&modelo=A3 SEDAN)' --header 'Authorization: Basic base64_encode(user:pass)'

[
    {
        "id": "2.0 PERFORMANCE BLACK 40 TFSI S-TRONIC (MHEV) 4-P Híbrido",
        "nome": "2.0 PERFORMANCE BLACK 40 TFSI S-TRONIC (MHEV) 4-P Híbrido",
        "id_marca": "AUDI",
        "nome_marca": "AUDI",
        "id_modelo": "A3 SEDAN",
        "nome_modelo": "A3 SEDAN"
    },
    ...
]

Obter motores

Utilizado para se obter as informações de todos os motores dos heículos que a MKSPEC possui em seu banco de dados.

Exemplo desse comando utilizando cURL:

Parâmetros

marca: é opcional e serve para filtrar por uma marca específica.
modelo: é opcional e serve para filtrar por um modelo específico.
versao: é opcional e serve para filtrar por uma versao específica.

curl --location --request GET 'https://api.mkspec.la/motores(?marca=AUDI&modelo=A3 SEDAN&versao=2.0 S-LINE 40 TFSI S-TRONIC (MHEV) 4-P Híbrido)' --header 'Authorization: Basic base64_encode(user:pass)'

[
    {
        "id": "2.0",
        "nome": "2.0",
        "id_marca": "AUDI",
        "nome_marca": "AUDI",
        "id_modelo": "A3 SEDAN",
        "nome_modelo": "A3 SEDAN",
        "id_versao": "2.0 S-LINE 40 TFSI S-TRONIC (MHEV) 4-P Híbrido",
        "nome_versao": "2.0 S-LINE 40 TFSI S-TRONIC (MHEV) 4-P Híbrido",
        "id_versao_completa": "AUDI A3 SEDAN 2.0 S-LINE 40 TFSI S-TRONIC (MHEV) 4-P Híbrido",
        "nome_versao_completa": "AUDI A3 SEDAN 2.0 S-LINE 40 TFSI S-TRONIC (MHEV) 4-P Híbrido"
    },
    ...
]

Obter os últimos veículos

Utilizado para se obter as informações os últimos veículos registrados.

Parâmetros

marca: é opcional e serve para filtrar por uma marca específica.

Exemplo desse comando utilizando cURL:

curl --location --request GET 'https://api.mkspec.la/ultimos-veiculos(?marca=BMW)' --header 'Authorization: Basic base64_encode(user:pass)'

[
  {
      "codigo_mkspec_anomodelo": 202240,
      "codigo_mkspec_versao": 81100,
      "marca": "BMW",
      "modelo": "118i",
      "versao": "1.5 M SPORT Aut. 5-P Gasolina",
      "versaoCompleta": "BMW 118i 1.5 M SPORT Aut. 5-P Gasolina",
      "cilindrada_L": "1.5",
      "ano_modelo": "2023",
      "fipe_id": "",
      "renavam": [],
      "data_atualizacao": "2022-08-29T14:11:34",
      "equipamentos_serie": [
            121,
            141,
            161,
            ...
      ],
      "dados_tecnicos": [
        {
            "combustivel_id": 11,
            "dado_tecnico_id": 251,
            "valor": "22,4"
        },
        ...
      ],
      "precos_publicos_sugeridos": [
        {
            "preco_id": 1138540,
            "data_tabela": "2022-06-01T00:00:00",
            "ano_fabricacao": "2022",
            "preco": 315950,
            "opcionais": [
                {
                    "opcional_id": 6052120,
                    "nome_completo": "PM (PINTURA METu00c1LICA)",
                    "codigo_descricao": "PM",
                    "descricao": "PINTURA METu00c1LICA",
                    "preco": 1700,
                    "vinculo": null,
                    "incompatibilidades": null,
                    "equipamentos": [
                        1461
                    ]
                }
            ]
        },
        ...
      ],
      "depreciacoes": [
        {
            "qtd_ano": 1,
            "valor": 0.1118
        },
        ...
      ]
  },
  ...
]

Otros dados

Obter lista de todos os tipos de combustíveis

Parâmetros

atualizacao: é opcional e serve para filtrar desde uma data de atualização até hoje.

Exemplo:

curl --location --request GET 'https://api.mkspec.la/combustivels' --header 'Authorization: Basic base64_encode(user:pass)'

[
  {
      "id": "0",
      "nome": "Indiferente"
  },
  {
      "id": "11",
      "nome": "Gasolina"
  },
  ...
]

Obter lista de todos os tipos de dados técnicos

Parâmetros

atualizacao: é opcional e serve para filtrar desde uma data de atualização até hoje.

Exemplo:

curl --location --request GET 'https://api.mkspec.la/dados_tecnicos' --header 'Authorization: Basic base64_encode(user:pass)'

[
  {
      "id": "11",
      "nome": "Identificação do motor"
  },
  {
      "id": "41",
      "nome": "Diâmetro de giro (publicado) (m)"
  },
  ...
]

Obter lista de todos os tipos de equipamentos de série

Parâmetros

atualizacao: é opcional e serve para filtrar desde uma data de atualização até hoje.

Exemplo:

curl --location --request GET 'https://api.mkspec.la/equipamentos_serie' --header 'Authorization: Basic base64_encode(user:pass)'

[
  {
      "id": "11",
      "nome": "Faróis com acendimento automático - ignição"
  },
  {
      "id": "21",
      "nome": "Faróis com aquecimento"
  },
  ...
]

Considerações sobre a arquitetura

Todas as respostas retornadas estão codificadas através do JSON.

JSON é um formato compacto, de padrão aberto independente baseado em texto leve projetado para troca de dados simples e rápida entre sistemas.
o Nossa API é compatível com JSON, tendo-o como padrão.

Todas as solicitações/respostas são codificadas em UTF-8.

UTF-8 8-bit Unicode Transformation Format) é um formato de codificação de caracteres Unicode e ISO 10646 utilizando símbolos de comprimento variável.
UTF-8 foi desenvolvido por Robert C. Pike y Kenneth L. Thompson. Está definido como padrão pela RFC 3629 da “Internet Engineering Task Force” (IETF).
Atualmente é uma das três possibilidades de codificação reconhecidas por Unicode e linguagens web, ou quatro na ISO 10646.

Documentação de Integração MKSPEC – Banco de Dados dos Veículos do Mercado Brasileiro

Introdução

Como utilizar a API

Autenticação Básica

Obter veículos

Obter marcas

Obter modelos

Obter versoes

Obter motores

Obter os últimos veículos

Otros dados

Obter lista de todos os tipos de combustíveis

Obter lista de todos os tipos de dados técnicos

Obter lista de todos os tipos de equipamentos de série

Considerações sobre a arquitetura

Todas as respostas retornadas estão codificadas através do JSON.

Todas as solicitações/respostas são codificadas em UTF-8.