ATENÇÃO: essa consulta se encontra em estágio beta, o que significa que podem haver alterações. Além disso apenas os Detrans MG, SP, PR, RS, SC, BA estão implementados no momento. |
O que é
Na consulta unificada de Detrans você verifica informações e a situação de um veículo através de apenas um endpoint e apenas um resultado. O resultado é mais resumido por isso é importe verificar se é adequado ao seu uso.
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/detran/{uf}
URL Base:
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros da URL
Nome | Tipo | Obrigatório? | Descrição |
---|---|---|---|
uf | String | Sim | Sigla do estado que deseja consultar. EX: mg |
Parâmetros do body
Os parâmetros são os mesmos utilizados na consulta original. Você pode verificar na lista de consultas o Detran que deseja, e lá está especificado os parâmetros de entrada.
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
|
Status 422
|
Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )
Estrutura base de resposta
Todos os campos podem retornar null
, quando um campo estiver com o valor null
significa que aquele Detran não retorna aquela informação, qualquer valor diferente de null
significa que o Detran retorno aquele valor.
{ "placa": null, "renavam": null, "chassi": null, "nomeProprietario": null, "municipio": null, "anoFabricacao": null, "anoModelo": null, "marca": null, "modelo": null, "cor": null, "especie": null, "tipoVeiculo": null, "categoria": null, "combustivel": null, "licenciamento": { "ano": null, "situacao": null }, "restricoes": [], "situacao": null, "ipva": { "ultimoAnoPago": null, "situacao": null }, "multas": [ { "descricao": null, "data": null, "valor": null } ], "infracoes": [ { "descricao": null, "data": null, "valor": null } ], "pdf": "JVBERi0xLjQKMSAwIG9iago8..." |
Resposta com erro
Todas as respostas de erro são as mesmas especificadas em cada Detran. Você pode verificar na lista de consultas o Detran que deseja, e lá está especificado os erros que podem retornar.