Comunicação de Venda

Esta API retorna registros de Comunicação de Venda do veículo.

Montando a requisição

Método da requisição

GET

Endereço da requisição

Principal:

https://api.activethread.com.br/detran/v1/communications/AAA1B11

Secundário:

https://api.detran.app.br/detran/v1/communications/AAA1B11

Parâmetros da requisição

Via URL

https://api.detran.app.br/detran/v1/communications/AAA1B11?at=XPTO

Via Cabeçalho

Authorization: XPTO

Respostas da requisição

200 - Sucesso

Observação: Os dados abaixo são apenas demonstrativos, com a finalidade de mapeamento da estrutura. Por isso, de forma alguma representam a realidade.

{
  "status": "DONE",
  "result": {
    "ocorrencias": [
      {
        "tipoDocumentoComprador": "CPF",
        "documentoComprador": "INFORMACAO OCULTADA",
        "ufImovelComprador": "MG",
        "codigoMunicipioComprador": "6213",
        "municipioComprador": "BARUERI-SP",
        "datadaVenda": "08/02/2019",
        "dataInicioCampanha": "14/02/2019",
        "horadoRegistro": "18:09:25",
        "indicadorCartorio": "1",
        "indicadorSituacao": "0",
        "situacao": "Inativo",
        "datadaSituacao": "14/02/2019",
        "horadaSituacao": "18:09:25"
      },
      {
        "tipoDocumentoComprador": "CGC",
        "documentoComprador": "INFORMACAO OCULTADA",
        "ufImovelComprador": "MG",
        "codigoMunicipioComprador": "4123",
        "municipioComprador": "BELO HORIZONTE-MG",
        "datadaVenda": "28/08/2024",
        "dataInicioCampanha": "13/09/2024",
        "horadoRegistro": "15:24:45",
        "indicadorCartorio": "2",
        "indicadorSituacao": "0",
        "situacao": "Inativo",
        "datadaSituacao": "13/09/2024",
        "horadaSituacao": "15:24:45"
      },
      {
        "tipoDocumentoComprador": "CPF",
        "documentoComprador": "INFORMACAO OCULTADA",
        "ufImovelComprador": "MG",
        "codigoMunicipioComprador": "4123",
        "municipioComprador": "BELO HORIZONTE-MG",
        "datadaVenda": "22/11/2024",
        "dataInicioCampanha": "23/11/2024",
        "horadoRegistro": "11:34:54",
        "indicadorCartorio": "2",
        "indicadorSituacao": "1",
        "situacao": "Ativo",
        "datadaSituacao": "23/11/2024",
        "horadaSituacao": "11:34:54"
      }
    ],
    "placa": "AAA1B11",
    "renavam": "INFORMACAO OCULTADA",
    "quantidadedeOcorrencias": "3"
  }
}

400 - Requisição inválida

Exemplo:

{
  "message": "Por favor, informe uma placa válida."
}

401 - Não autorizado

{
  "message": "Não autorizado."
}

403 - Acesso negado

{
  "message": "Acesso negado!"
}

Exemplos da requisição - Autenticação via URL

HTTP

GET /detran/v1/communications/AAA1B11 HTTP/1.1
Host: api.activethread.com.br

cURL

curl --location 'https://api.activethread.com.br/detran/v1/communications/AAA1B11

JavaScript

const requestOptions = {
  method: "GET",
  redirect: "follow",
};
 
fetch(
  "https://api.activethread.com.br/detran/v1/communications/AAA1B11?at=XPTO",
  requestOptions
)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

NodeJs

const axios = require("axios");
 
let config = {
  method: "get",
  maxBodyLength: Infinity,
  url: "https://api.activethread.com.br/detran/v1/communications/AAA1B11?at=XPTO",
  headers: {},
};
 
axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

PHP

<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.activethread.com.br/detran/v1/communications/AAA1B11?at=XPTO',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));
 
$response = curl_exec($curl);
 
curl_close($curl);
echo $response;

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://api.activethread.com.br/detran/v1/communications/AAA1B11?at=XPTO")
  .asString();

Python

import requests
 
url = "https://api.activethread.com.br/detran/v1/communications/AAA1B11?at=XPTO"
 
payload = {}
headers = {}
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)

Exemplos da requisição - Autenticação via Cabeçalho