O que é#
Na Consulta ANTT - Registro Nacional de Transportadores Rodoviários de Cargas - é possível visualizar informações sobre um transportador, se está registrado (Registro Nacional de Transportadores Rodoviários de Cargas) e se apto a transportar cargas de forma remunerada.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/antt/rntrc
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 |
|---|---|---|---|
| cpfCnpj | string | Somente se rntrc não for informado |
CPF ou CNPJ do transportador, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
| rntrc | string | Somente se cpfCnpj não for informado |
RNTRC do transportador. |
| placa | string | Não | Placa do veículo a ser pesquisado. |
Estrutura da resposta#
| 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 quando você faz a requisição#
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)#
Valores possíveis do campo "status"
| Status | Significado |
|---|---|
| ativo | Registro existe e está apto a realizar transporte remunerado |
| pendente | Registro existe, mas está com alguma pendência |
| cancelado | Registro cancelado |
| suspenso | Registro suspenso |
| vencido | Registro vencido |
| suspensao_cautelar | Registro com suspensão cautelar |
| erro | Nenhum registro encontrado para os dados informados |
Valores possíveis do campo "statusVeiculo"
| Status | Significado |
|---|---|
| cadastrado | Indica que a mensagem de status do veículo contém o texto pode ser utilizado para o transporte |
| nao_cadastrado | Indica que a mensagem de status do veículo contém o texto Não está cadastrado na frota |
Resposta com registro encontrado
JSON
{
"status": "ativo",
"statusVeiculo": "cadastrado",
"transportador": "FULANO DE TAL",
"cpfCnpj": "999.999.999-99",
"rntrc": "999999999",
"dataCadastro": "01/01/2020",
"dataValidade": "01/01/2020",
"municipioUf": "Cidade Exemplo/UF",
"dadosVeiculo": {
"tipo": "Veículo Automotor",
"placa": "ABC1234",
"identificacaoEletronica": "Não instalada"
},
"observacao": "Esse transportador está apto a realizar o transporte remunerado de cargas.",
"pdf": "{PDF EM BASE64}"
}JSON
{
"status": "pendente",
"statusVeiculo": "",
"transportador": "FULANO DE TAL",
"cpfCnpj": "999.999.999-99",
"rntrc": "999999999",
"dataCadastro": "01/01/2020",
"dataValidade": "01/01/2020",
"municipioUf": "Cidade Exemplo/UF",
"dadosVeiculo": null,
"observacao": "Esse transportador NÃO está apto a realizar o transporte remunerado de cargas.",
"pdf": "{PDF EM BASE64}"
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "RNTRC inválido",
"pdf": "{PDF EM BASE64}"
}JSON
{
"status": "erro",
"mensagem": "Não foram encontrados transportadores para o filtro informado.",
"pdf": "{PDF EM BASE64}"
}
