Documentacao da API

API REST v1 do MinasVeiculos para integracao de lojistas e sistemas

Inicio Rapido

Crie sua conta

Cadastre-se no portal MinasVeiculos como pessoa fisica ou juridica.

Gere sua chave de API

Acesse Chaves de API no menu do seu perfil e clique em "Nova Chave".

Faca sua primeira requisicao

Envie o header X-API-Key: mv_sua_chave em cada chamada.

Base URL

https://minasveiculos.com.br/api/v1

Autenticacao

Todas as requisicoes (exceto gestao de chaves) devem incluir a chave de API em um destes formatos:

X-API-Key: mv_sua_chave_aqui

Authorization: Bearer mv_sua_chave_aqui

Codigos de Resposta

200 OK

201 Criado

400 Invalido

401 Nao autenticado

403 Sem permissao

404 Nao encontrado

500 Erro interno

Permissoes

Cada chave de API tem permissoes associadas:

vehicles:readListar e visualizar veiculos

vehicles:writeCriar, editar e excluir veiculos

catalog:readConsultar marcas e modelos FIPE

Autenticacao

Gerencie suas chaves de API. A criacao e listagem de chaves requerem sessao autenticada no portal (cookie). Todos os outros endpoints usam a chave de API no header.

Veiculos

CRUD completo de veiculos. Todos os endpoints requerem chave de API com a permissao adequada.

Fotos

Gerencie as fotos dos veiculos. Maximo de 10 fotos por veiculo.

Catalogo FIPE

Consulte marcas e modelos da tabela FIPE para preenchimento correto dos veiculos.

Precisa de ajuda? Entre em contato pelo portal ou envie um email para suporte.