Consultas e Eventos
Consultas
Consulta é o meio através do qual o frotista obtém informações a respeito dos seus veículos no e-Frotas.
Importante
Importante: Substitua as informações entre chaves {} nos exemplos deste manual pelas informações que você deseja procurar.
Endereço do Serviço: Para o ambiente de homologação (teste com dados fictícios), o endereço é: https://hom-efrotas.estaleiro.serpro.gov.br/efrotas/api/ Para o ambiente de produção (com acesso a dados reais), o endereço é: https://efrotas.estaleiro.serpro.gov.br/efrotas/api/
Exemplos de Consultas:
Consulta o PDF de Notificação de Autuação no SNE
GET
/consultas/sne/pdf/placa/{placa}/codigoOrgao/{codigoOrgao}/numeroAit/{numeroAit}/codigoInfracao/{codigoInfracao}/NA
Parâmetros
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| placa | A placa do veículo que houve a infração | string | Sim |
| codigoOrgao | O código do órgão autuador da infração | string | Sim |
| numeroAit | O número do auto de infração | string | Sim |
| codigoInfracao | O código da infração | string | Sim |
Exemplo de Requisição
bash
curl -X GET "https://{endereço_efrotas}/consultas/sne/pdf/placa/ABC0A01/codigoOrgao/123/numeroAit/456/codigoInfracao/789/NA" -H "accept: application/json"
Resposta
json
{
"placa": "ABC0A01",
"filename": "nome_do_arquivo.pdf",
"chaveInfracao": "chave_da_infracao",
"base64": "base64_do_arquivo"
}
Consultar dados de uma infração a partir da sua chave
GET
/consultas/v1/infracoes/codigoOrgao/{codigoOrgao}/numeroAit/{numeroAit}/codigoInfracao/{codigoInfracao}
Parâmetros
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| codigoOrgao | O código do órgão | string | Sim |
| numeroAit | O número do auto de infração | string | Sim |
| codigoInfracao | O código da infração | string | Sim |
Exemplo de Requisição
bash
curl -X GET " {endereço_efrotas} /consultas/v1/infracoes/codigoOrgao/123/numeroAit/456/codigoInfracao/789" -H "accept: application/json"
Resposta
json
{
"codigoOrgaoAutuador": "123",
"numeroAutoInfracao": "456",
"codigoInfracao": "789",
"ufOrgaoAutuador": "SP",
"valorIntegralInfracao": 100.00,
"descricaoInfracao": "Infração de trânsito",
"dataVencimentoPenalidade": "2022-01-01",
"dataPagamento": "2022-01-15",
"dataRegistroPagamento": "2022-01-15",
"placa": "ABC0A01",
"gravidade": "Leve",
"dataLimiteDefesaAutuacao": "2022-01-15",
"localAutuacao": "São Paulo",
"descricaoMunicipioAutuacao": "São Paulo",
"codigoMunicipioAutuacao": 3550308,
"codigoDesdobramento": "123",
"nomePossuidorOriginal": "João da Silva",
"numeroDocumentoPossuidorOriginal": "123456789",
"numeroDocumentoInfratorConsiderado": "987654321",
"dataAutuacao": "2022-01-01",
"horaAutuacao": "10:00:00",
"dataEmissaoNotificacaoAutuacao": "2022-01-01",
"dataEmissaoNotificacaoPenalidade": "2022-01-15",
"medicaoReal": 100.00,
"limitePermitido": 100.00,
"renainf": 0,
"nomePossuidor": "João da Silva",
"numeroDocumentoPossuidor": "123456789",
"siglaUfLocalAutuacao": "SP",
"descricaoPaisOrigemVeiculo": "Brasil",
"indicadorExigibilidade": true,
"indicadorFotoRecebida": true,
"indicadorCanceladaSuspensa": true,
"renainfOriginario": 0,
"chaveDaInfracaoOriginal": {
"codigoOrgaoAutuador": "123",
"numeroAutoInfracao": "456",
"codigoInfracao": "789"
},
"codigoEquipamentoAfericao": "123",
"codigoAgenteFiscalizador": "456",
"observacoes": "Observação da infração",
"versao": "1.0"
}
Consultar todos os veículos de um CNPJ ou todos os veículos de uma filial
GET
/consultas/v1/veiculos
Parâmetros
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| cnpjFilial | O CNPJ da filial | string | Não |
| pagina | A página da consulta | integer | Não |
| quantidade | A quantidade de veículos por página | integer | Não |
Exemplo de Requisição
bash
curl -X GET " {endereço_efrotas} /consultas/v1/veiculos?cnpjFilial=123456789&pagina=1&quantidade=20" -H "accept: application/json"
Resposta
json
[
{
"placa": "ABC0A01",
"renavam": "123456789",
"descricaoMarcaModelo": "Fiat Uno",
"anoFabricacao": 2000,
"anoModelo": 2001,
"chassi": "123456789",
"quantidadeTotalRestricoes": 0,
"versao": "1.0"
},
{
"placa": "DEF0B02",
"renavam": "987654321",
"descricaoMarcaModelo": "Volkswagen Gol",
"anoFabricacao": 2001,
"anoModelo": 2002,
"chassi": "987654321",
"quantidadeTotalRestricoes": 0,
"versao": "1.0"
}
]
Recebendo Eventos da sua Frota
Além das consultas, o e-Frotas oferece para seus clientes os eventos, também relacionados à sua frota.
A documentação dos eventos com campos e dicionários de dados pode ser acessado neste link.
Você frotista, pode indicar um endpoint (com ou sem header) e nós vamos depositar a informação de um evento para você através de uma requisição REST fazendo uma chamada POST.
Esse endpoint ou webhook é cadastrado por você através da API de gerenciamento do e-Frotas e você poderá escolher quais eventos deseja ou não deseja receber. Por padrão, todos os eventos nascem configurados como inativos e somente a empresa consegue indicar que deseja ativar o envio de um novo evento. 
O payload dos eventos está no manual e adicionamos o tipo do evento (numérico que identifica o evento) e o código de rastreamento que é um UUID usado como link entre as bases do frotista e do SERPRO e pode ser usado para auxiliar na identificação de possíveis intercorrências.
Segue um exemplo:
Criada: 8 de novembro de 2024