API Consultar Placa V1

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.

Consultar uma Placa

POST https://api.consultarplaca.com.br/v1/consultarPlaca

Registra solicitação de consulta de uma placa e retorna um protocolo para acompanhamento da solicitação.

Headers

Name	Type	Description
Authorization	string	Autenticação por BasicAuth

Request Body

Name	Type	Description
placa	string	Placa do Veículo. Placa deve possuir os seguintes formatos: AAA9999 ou AAA9A99
tipo_consulta	string	Tipo da consulta. Valores possíveis: - basica - bronze - prata - ouro
url_notificacao	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	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.

200 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/v1/consultarProtocolo?protocolo=XXXXXXXXXXXXXXX",
    "request": [
        "placa": "AAA9999",
        "tipo_consulta": "basica"
    ]
}

400 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"
    }
}   

Consultar Protocolo - Retorna resultado e uma consulta.

GET https://api.consultarplaca.com.br/v1/consultarProtocolo

Retorna o resultado da consulta de uma placa previamente registrada através da rota /v1/consultarPlaca

Headers

Name	Type	Description
Authorization	string	Autenticação por BasicAuth

Request Body

Name	Type	Description
protocolo	string	Protocolo retornado no momento do registro da consulta (Rota /v1/consultarPlaca)

200 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. - finalizada: Relatório já finalizado e disponível para download.

em_processamento

{
    "status": "ok",
    "mensagem": "Consulta em processamento.",
    "situacao_consulta": "em_processamento",
    "dados": [],
    "request": {
        "protocolo": "ABCDEFG"
    }
}

finalizada

{
    "status": "ok",
    "mensagem": "Consulta realizada com sucesso.",
    "situacao_consulta": "finalizada",
    "protocolo": "ABCDEFG",
    "dados": {
        "url_pdf": "http://app.consultarplaca.com/cp/d/XXXXXXXXXXXXX"
    },
    "request": {
        "protocolo": "ABCDEFG"
    }
}