O que é#

Consulta pública sobre informações de situações de veículos cadastrados no Detran RJ.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/detran-rj/veiculos/consulta-cadastro-veiculo

Parâmetros do header#

Nome Tipo Obrigatório? Descrição
Authorization String Sim Chave de API gerada no cadastro no Plexi, prefixada com Bearer
Callback String Não URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body#

Nome Tipo Obrigatório? Descrição
placa string Sim Placa do veículo a ser pesquisado.

Retornos possíveis da requisição#

Status Significado Descrição Informações retornadas
201 Created Solicitação criada Campo requestId, com o ID da requisição criada.
422 Unprocessable Entity A solicitação contém erro Em quais campos houve erro.

Exemplos de retornos#

Status 201

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

JSON
{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

JSON
{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )#

Resposta com registro encontrado

JSON
{
    "mensagem": "",
    "licenciamento": "2020",
    "nome": "FULANO DE TAL",
    "placa": "ABC1234",
    "placaAnterior": "ABC0000",
    "chassi": "****************",
    "especie": "PASSAGEIRO",
    "combustivel": "ALCO/GASOL",
    "marca": "FIAT/DOBLO ADV 1.8 FLEX",
    "anoFabricacao": "2012",
    "anoModelo": "2012",
    "capacidade": "6 / 132 / 1800",
    "categoria": "PARTICULAR",
    "cor": "BRANCO",
    "observacoes": "",
    "local": "RIO DE JANEIRO",
    "pdf": "JVBERi0xLjQKMSAwIG9iago8PAovVGl0bGUgKP7..."
}

Resposta com erro

JSON
{
    "status": "erro",
    "mensagem": "Veículo não cadastrado na base estadual (RJ)."
}