Dispara o rastreamento de um veículo (assíncrona)

curl --request POST \
  --url https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "document": "ABC1D23",
  "url_retorno": "https://cliente.exemplo.com/webhooks/jusfy"
}
'

import requests

url = "https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular"

payload = {
    "document": "ABC1D23",
    "url_retorno": "https://cliente.exemplo.com/webhooks/jusfy"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: 'ABC1D23', url_retorno: 'https://cliente.exemplo.com/webhooks/jusfy'})
};

fetch('https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document' => 'ABC1D23',
    'url_retorno' => 'https://cliente.exemplo.com/webhooks/jusfy'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "statusCode": 202,
  "message": "Consulta assíncrona aceita",
  "timestamp": "2026-09-02T18:00:00.000Z",
  "path": "/api/consultas/rastreamento-veicular",
  "result": {
    "id": "aqry_1f0b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
    "consulta": "rastreamento-veicular",
    "status": "pending",
    "createdAt": "2026-09-02T18:00:00.000Z",
    "expiresAt": "2026-09-02T18:10:00.000Z",
    "statusUrl": "/api/consultas/rastreamento-veicular/aqry_1f0b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
    "url_retorno": "https://cliente.exemplo.com/webhooks/jusfy",
    "signingSecret": "whsec_kQ8yq2Vx1pN7mJ4rT6sW9zL0aB3cD5eF7gH1iK2lM4o"
  }
}

Consultas

Dispara o rastreamento de um veículo (assíncrona)

Inicia a busca por capturas do veículo em câmeras de monitoramento nos últimos 12 meses. A consulta não responde na hora: o fornecedor processa por lote e pode levar minutos, então esta rota devolve 202 com um protocolo.

Há duas formas de obter o resultado, que podem ser combinadas: informar um url_retorno e receber o webhook assim que terminar, ou consultar GET /api/consultas/rastreamento-veicular/{id}.

A consulta é cobrada neste disparo, não na entrega — inclusive se o lote depois expirar. Não há deduplicação: dois disparos para a mesma placa são duas consultas cobráveis. Em caso de erro de rede sem resposta, prefira consultar antes de repetir.

POST

api

consultas

rastreamento-veicular

Dispara o rastreamento de um veículo (assíncrona)

curl --request POST \
  --url https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "document": "ABC1D23",
  "url_retorno": "https://cliente.exemplo.com/webhooks/jusfy"
}
'

import requests

url = "https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular"

payload = {
    "document": "ABC1D23",
    "url_retorno": "https://cliente.exemplo.com/webhooks/jusfy"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document: 'ABC1D23', url_retorno: 'https://cliente.exemplo.com/webhooks/jusfy'})
};

fetch('https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jusfy.dev/calculators/api/consultas/rastreamento-veicular",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'document' => 'ABC1D23',
    'url_retorno' => 'https://cliente.exemplo.com/webhooks/jusfy'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "statusCode": 202,
  "message": "Consulta assíncrona aceita",
  "timestamp": "2026-09-02T18:00:00.000Z",
  "path": "/api/consultas/rastreamento-veicular",
  "result": {
    "id": "aqry_1f0b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
    "consulta": "rastreamento-veicular",
    "status": "pending",
    "createdAt": "2026-09-02T18:00:00.000Z",
    "expiresAt": "2026-09-02T18:10:00.000Z",
    "statusUrl": "/api/consultas/rastreamento-veicular/aqry_1f0b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
    "url_retorno": "https://cliente.exemplo.com/webhooks/jusfy",
    "signingSecret": "whsec_kQ8yq2Vx1pN7mJ4rT6sW9zL0aB3cD5eF7gH1iK2lM4o"
  }
}

Autorizações

x-api-key

string

header

obrigatório

Corpo

application/json

document

string

obrigatório

Placa do veículo, no formato antigo (ABC1234) ou Mercosul (ABC1D23). Pode ser enviada com máscara — separadores são ignorados.

Exemplo:

"ABC1D23"

url_retorno

string

URL https que receberá o resultado quando a consulta terminar. Opcional: sem ela, o resultado é obtido apenas pelo GET do protocolo. Deve apontar para um domínio público na porta 443 — endereços IP, hosts internos e http são recusados. A entrega é assinada; o segredo vem no campo signingSecret desta resposta e não é exibido novamente.

Exemplo:

"https://cliente.exemplo.com/webhooks/jusfy"

Resposta

Consulta aceita e em processamento. Guarde o id — e o signingSecret, que não é exibido novamente.

The response is of type object.

Legado

Calculadoras

Consultas

JusScore

Health

Dispara o rastreamento de um veículo (assíncrona)

Autorizações

Corpo

Resposta