Pular para conteúdo

Consulta Executivo v3.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Authentication

  • API Key (ApiKey)
    • Parameter Name: X-API-Key, in: header.

🚦 Consulta Executivo

Endpoints para órgãos executivos de trânsito.

get__consulta_orgao_executivo

Code samples

# You can also use wget
curl -X GET /consulta/orgao/executivo?placa=ABC1234&dataInicio=2026-01-01&dataFim=2026-01-31 \
  -H 'Accept: application/json'
GET /consulta/orgao/executivo?placa=ABC1234&dataInicio=2026-01-01&dataFim=2026-01-31 HTTP/1.1

Accept: application/json
const headers = {
  'Accept':'application/json'
};

fetch('/consulta/orgao/executivo?placa=ABC1234&dataInicio=2026-01-01&dataFim=2026-01-31',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/consulta/orgao/executivo',
  params: {
  'placa' => 'string',
'dataInicio' => 'string(date)',
'dataFim' => 'string(date)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/consulta/orgao/executivo', params={
  'placa': 'ABC1234',  'dataInicio': '2026-01-01',  'dataFim': '2026-01-31'
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/consulta/orgao/executivo', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("/consulta/orgao/executivo?placa=ABC1234&dataInicio=2026-01-01&dataFim=2026-01-31");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/consulta/orgao/executivo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /consulta/orgao/executivo

🚛 Consultar passagens por placa e período

Retorna passagens de veículo filtradas pelo e-CNPJ do órgão executivo autenticado via certificado mTLS.

📋 Dados Obrigatórios:

  • Placa do veículo
  • Data de início do período
  • Data de fim do período

    ⚠️ Regras de Validação:

    • O período máximo permitido é de 1 mês a partir da data de início.
    • A data de fim não pode ser anterior à data de início.
    • A data de fim não pode ser posterior à data atual.

Parameters

Name In Type Required Description
placa query string true none
dataInicio query string(date) true none
dataFim query string(date) true none

Example responses

200 Response

{
  "cnpj": "string",
  "passagens": [
    {
      "placa": "string",
      "dataHoraPassagem": "string",
      "dataEntrada": "string",
      "dataSaida": "string",
      "situacaoPagamento": "PAGO",
      "dataHoraPagamento": "string",
      "concessionaria": {
        "cnpj": "string",
        "razaoSocial": "string",
        "nomeConcessao": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Passagens retornadas com sucesso ConsultaExecutivoResponse
400 Bad Request Parâmetros inválidos ou período superior a 1 mês HttpProblem
401 Unauthorized Certificado cliente ausente ou inválido HttpProblem
403 Forbidden CNPJ não corresponde a nenhum órgão executivo cadastrado HttpProblem
404 Not Found Órgão executivo sem concessionárias vinculadas para os parâmetros solicitados HttpProblem

Schemas

ConcessionariaExecutivoDto

{
  "cnpj": "string",
  "razaoSocial": "string",
  "nomeConcessao": "string"
}

Properties

Name Type Required Restrictions Description
cnpj string false none CNPJ da concessionária
razaoSocial string false none Razão social da concessionária
nomeConcessao string false none Nome da concessão

ConsultaExecutivoResponse

{
  "cnpj": "string",
  "passagens": [
    {
      "placa": "string",
      "dataHoraPassagem": "string",
      "dataEntrada": "string",
      "dataSaida": "string",
      "situacaoPagamento": "PAGO",
      "dataHoraPagamento": "string",
      "concessionaria": {
        "cnpj": "string",
        "razaoSocial": "string",
        "nomeConcessao": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
cnpj string false none CNPJ do órgão
passagens [PassagemExecutivoDto] false none Lista de passagens relacionadas ao órgão executivo de trânsito

HttpProblem

{
  "type": "https://example.com/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Record not found",
  "instance": "https://api.example.com/errors/123"
}

HTTP Problem Response according to RFC9457 and RFC7807

Properties

Name Type Required Restrictions Description
type string(uri) false none A optional URI reference that identifies the problem type
title string false none A optional, short, human-readable summary of the problem type
status integer(int32) false none The HTTP status code for this occurrence of the problem
detail string false none A optional human-readable explanation specific to this occurrence of the problem
instance string(uri) false none A URI reference that identifies the specific occurrence of the problem

PassagemExecutivoDto

{
  "placa": "string",
  "dataHoraPassagem": "string",
  "dataEntrada": "string",
  "dataSaida": "string",
  "situacaoPagamento": "PAGO",
  "dataHoraPagamento": "string",
  "concessionaria": {
    "cnpj": "string",
    "razaoSocial": "string",
    "nomeConcessao": "string"
  }
}

Properties

Name Type Required Restrictions Description
placa string false none Placa do veículo
dataHoraPassagem string false none Data e hora da passagem
dataEntrada string false none Data e hora de entrada
dataSaida string false none Data e hora de saída
situacaoPagamento string false none Situação do pagamento
dataHoraPagamento string false none Data e hora do pagamento
concessionaria ConcessionariaExecutivoDto false none Concessionária associada à passagem

Enumerated Values

Property Value
situacaoPagamento PAGO
situacaoPagamento PAGO_FORA_DO_PRAZO
situacaoPagamento NAO_PAGO