Page Comparison

O que é

Na consulta Detran AL - Consulta de Veículo - você verifica informações e a situação de um veículo com placa registrada em Alagoas:

...

Veja mais informações em nossa central de ajuda: Detran AL - Consulta de Veículo

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran-al/veiculos/consulta-veiculo

...

Include Page

	URL Base
	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 `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.
renavam	string	Sim	Renavam 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

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

...

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

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

Resposta com registro encontrado

...

Renavam inválido:

Code Block

language	json

{
  "status":"erro",
  "mensagem":"renavam inválido ou não cadastrado."
}

...

Versions Compared