Status da Execução

Esta é a chamada padrão para verificar o estágio de conclusão da execução do produto. Deve ser chamada de forma contínua até que o processamento dos dados seja concluído (isto acontece quando o status de retorno é diferente de PROCESSING).

Como se trata de um retorno simplificado, seu tempo de resposta também fica abaixo de 1 segundo.

Em geral, recomendamos uma cadência de 10 segundos entre as chamadas.

Montando a requisição

Método da requisição

GET

Endereço da requisição

Homologação:

https://apipreview.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status

Produção:

https://api.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status

Cabeçalho da requisição

{
    "Authorization": "Bearer token",
    "Content-Type": "application/json"
}

No parâmetro Authorization você vai informar o valor do token recuperado anteriormente.

Por exemplo:

{
    "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ",
    "Content-Type": "application/json"
}

Respostas da requisição

200 - Sucesso

{
    "id": "657caf08255ca770829ae3d0",
    "plate": "ABC1234",
    "partner": true,
    "integration": true,
    "type": "ESPECIAL",
    "tags": [
        {
            "value": "VOLKSWAGEN / TIGUAN 2.0 TSI - 2010/2010",
            "pickupOrTruck": true
        },
        {
            "value": "RENAVAM: 12345678901"
        },
        {
            "value": "Chassi: 92G1234567890"
        },
        {
            "value": "Motor: T1234567"
        },
        {
            "value": "Indício de Sinistro",
            "casualty": true
        },
        {
            "value": "Leilão - Score: 1",
            "auction": true
        },
        {
            "value": "Histórico KM",
            "km": true
        },
        {
            "value": "Histórico Proprietários",
            "owners": true
        },
        {
            "value": "Recall",
            "recall": true
        },
        {
            "value": "Restrições Estaduais",
            "restriction": true
        },
        {
            "value": "Renainf",
            "taxes": true
        },
        {
            "value": "UF: MG",
            "state": "MG"
        }
    ],
    "photos": [],
    "status": "DONE",
    "notifiedAt": "2023-12-15T19:54:48.348Z",
    "executedAt": "2023-12-15T19:54:48.349Z",
    "createdAt": "2023-12-15T19:54:48.350Z",
    "updatedAt": "2023-12-15T19:55:01.285Z",
    "issues": {
        "brokenItems": []
    },
    "user": {
        "_id": "611fa8e1d756fbcfbcdd164c",
        "name": "Test AboutCar",
        "id": "611fa8e1d756fbcfbcdd164c"
    },
    "product": {
        "_id": "62296e56fb8bbaa4920e87a1",
        "name": "Especial",
        "id": "62296e56fb8bbaa4920e87a1"
    },
}

A propriedade status aqui demonstra o estágio de processamento dos dados.

Possíveis Valores

PROCESSING: Em processamento
- Enquanto estiver Em processamento, continuar realizando chamadas com uma cadência de 10 segundos entre elas.
DONE: Concluído
- Quando estiver concluído, já será possível executar a próxima chamada para recuperar os dados.
ERROR: Erro
- Caso seja finalizado com erro, a propriedade error conterá o motivo do erro.

401 - Não autorizado

{
    "message": "Unauthorized!"
}

Exemplos da requisição

HTTP

GET /v1/integration/histories/657caf08255ca770829ae3d0/status HTTP/1.1
Host: apipreview.aboutcar.com.br
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ

cURL

curl --location 'https://apipreview.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ'

JavaScript

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ");
 
const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};
 
fetch("https://apipreview.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

NodeJs

const axios = require('axios');
 
const config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://apipreview.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status',
  headers: { 
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ'
  }
};
 
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://apipreview.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status',
  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',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ'
  ),
));
 
$response = curl_exec($curl);
 
curl_close($curl);
echo $response;

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://apipreview.aboutcar.com.br/v1/integration/histories/657caf08255ca770829ae3d0/status")
  .header("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MTFmYThlMWQ3NTZmYmNmYmNkZDE2NGMiLCJlbWFpbCI6InRlc3RAYWJvdXRjYXIuY29tLmJyIiwiaWF0IjoxNzAyNjU3MTExLCJleHAiOjE3MDI2ODU5MTF9.nw3W7jBulG_QW5cF_KTMdsCy-sB_c-FE47FUAgOzbFQ")
  .asString();

3.2 - Chamada Assíncrona 3.2.2 - Dados