API Consultar Placa v2.0

API para consultar o histórico de qualquer veículo através de sua placa.

Autenticação

Todas as rotas exigem autenticação Basic Auth. Para isso você deve utilizar seu email e api_key. Para obter sua api_key entre em contato com nossa equipe.

get
Consultar Placa

https://api.consultarplaca.com.br/v2/consultarPlaca
Retorna dados de um veículo através de sua placa
Request
Response
Request
Headers
Authorization
required
string
Autenticação por BasicAuth
Query Parameters
placa
required
string
Placa do Veículo. Placa deve possuir os seguintes formatos: AAA9999 ou AAA9A99
Response
200: OK
Consulta realizada com sucesso.
{
"status": "ok",
"mensagem": "Consulta realizada com sucesso!",
"data_solicitacao": "2020-11-22 16:54:10",
"dados": {
"informacoes_veiculo": {
"dados_veiculo": {
"placa": "AAA9999",
"chassi": "9AAAA99AAAA999999",
"ano_frabricacao": "2014",
"ano_modelo": "2015",
"marca": "HYUNDAI",
"modelo": "HYUNDAI/HB20 1.0M COMFOR",
"cor": "Branca",
"segmento": "Auto",
"combustivel": "Álcool / Gasolina",
"procedencia": "Nacional",
"municipio": "MARINGA",
"uf_municipio": "PR"
},
"dados_tecnicos": {
"tipo_veiculo": "Automovel",
"sub_segmento": "AU - HATCH PEQUENO",
"numero_motor": "A9AAAA999999",
"numero_caixa_cambio": "AA999999999",
"potencia": "80",
"cilindradas": "998"
},
"dados_carga": {
"numero_eixos": "2",
"capacidade_maxima_tracao": "182",
"capacidade_passageiro": "5"
}
}
},
"request": {
"placa": "AAA9999"
}
}
400: Bad Request
Situações em que ocorrer um problema que inviabiliza o retorno da consulta. Possíveis casos: - Placa informada é inválida. - Placa não encontrada em nossa base. Neste caso é retornado o campo tipo_do_erro com o valor placa_nao_encontrada - Serviço indisponível. Situação em que não foi possível comunicação com nossos fornecedores. Neste caso é retornado o campo tipo_do_erro com o valor servico_indisponivel
Placa Inválida
placa_nao_encontrada
servico_indisponivel
Placa Inválida
{
"status": "erro",
"mensagem": "Placa informada é invalida. Placa deve possuir o formato conforme exemplos: AAA9999 ou AAA9A99!",
"request": {
"placa": "AAA022"
}
}
placa_nao_encontrada
{
"status": "erro",
"tipo_do_erro": "placa_nao_encontrada",
"mensagem": "Nenhum resultado encontrado para placa pesquisada!",
"request": {
"placa": "AAA0000"
}
}
servico_indisponivel
{
"status": "erro",
"tipo_do_erro": "servico_indisponivel",
"mensagem": "Não foi possível completar sua pesquisa. Fornecedores temporariamente indisponíveis. Tente novamente em alguns minutos!",
"request": {
"placa": "AAA0000"
}
}
403: Forbidden
Ocorre caso sua conta ainda não esteja habilitada para utilizar a consulta solicitada.
{
"status": "erro",
"mensagem": "Tipo de consulta não habilitada para sua conta. Entre em contato ([email protected]) para habilitar esta consulta!",
"request": {
"placa": "AYX2416"
}
}

post
Solicitar Relatório uma Placa

https://api.consultarplaca.com.br/v2/solicitarRelatorio
Registra solicitação de consulta de uma placa e retorna um protocolo para acompanhamento da solicitação.
Request
Response
Request
Headers
Authorization
required
string
Autenticação por BasicAuth
Body Parameters
placa
required
string
Placa do Veículo. Placa deve possuir os seguintes formatos: AAA9999 ou AAA9A99
tipo_consulta
required
string
Tipo da consulta. Valores possíveis: - basica - bronze - prata - ouro
url_notificacao
optional
string
URL para onde será enviado a notificação quando a consulta estiver pronta. Quando enviado este parâmetro assim que finalizado o processamento do relatório uma notificação POST será enviada com um formato JSON conforme exemplo abaixo: { "protocolo":"ABCDEF", "dados":{ "url_pdf":"http://app.consultarpla...." } }
consulta_para_revenda
optional
boolean
Identificação se o relatório deve ou não ser gerado no formato de revenda. 1 para SIM. Neste caso o relatório será gerado com a logo, cor e endereço do site do revendedor. 0 para NÃO. Neste caso o relatório é gerado com a identidade visual do Consultar Placa. O valor padrão deste campo é 0 (NÃO). * Para gerar relatório como revenda é necessário credenciar sua conta junto a nossa equipe.
Response
200: OK
Consulta solicitada com sucesso.
{
"status": "ok",
"mensagem": "Consulta solicitada com sucesso!",
"data_solicitacao": "2019-08-25 16:51:24",
"protocolo": "XXXXXXXXXXXXXXX",
"link_resultado": "https://api.consultarplaca.com.br/v2/consultarProtocolo?protocolo=XXXXXXXXXXXXXXX",
"request": [
"placa": "AAA9999",
"tipo_consulta": "basica"
]
}
400: Bad Request
Rota inválida.
{
"status": "erro",
"mensagem": "Placa informada é invalida. Placa deve possuir o formato conforme exemplos: AAA9999 ou AAA9A99!",
"request": {
"placa": "AAAA",
"tipo_consulta": "basica"
}
}

get
Consultar Protocolo - Retorna resultado e uma solicitação de relatório.

https://api.consultarplaca.com.br/v2/consultarProtocolo
Retorna o resultado da consulta de uma placa previamente registrada através da rota /v2/solicitarRelatorio
Request
Response
Request
Headers
Authorization
required
string
Autenticação por BasicAuth
Body Parameters
protocolo
optional
string
Protocolo retornado no momento do registro da consulta (Rota /v2/solicitarRelatorio)
Response
200: OK
Requisição realizada com sucesso. Situação de uma consulta (campo situacao_consulta) pode possuir o seguintes valores: - em_processamento: Relatório ainda não esta finalizado. - parcialmente_finalizada: Relatório já regado e uma versão parcial está disponível para download. Situação ocorre quando alguma informação ainda não foi disponibilizada. - finalizada: Relatório já finalizado e disponível para download.
em_processamento
parcialmente_finalizada
finalizada
em_processamento
{
"status": "ok",
"mensagem": "Consulta em processamento.",
"situacao_consulta": "em_processamento",
"dados": [],
"request": {
"protocolo": "ABCDEFG"
}
}
parcialmente_finalizada
{
"status": "ok",
"mensagem": "Consulta realizada com sucesso.",
"situacao_consulta": "parcialmente_finalizada",
"protocolo": "ABCDEFG",
"dados": {
"url_pdf": "https://app.consultarplaca.com.br/cp/d/XXXXXXXXXXXXX"
},
"request": {
"protocolo": "ABCDEFG"
}
}
finalizada
{
"status": "ok",
"mensagem": "Consulta realizada com sucesso.",
"situacao_consulta": "finalizada",
"protocolo": "ABCDEFG",
"dados": {
"url_pdf": "https://app.consultarplaca.com.br/cp/d/XXXXXXXXXXXXX"
},
"request": {
"protocolo": "ABCDEFG"
}
}