Autenticação

A API Checktudo utiliza API Key para autenticação. Todas as requisições devem incluir sua chave no header x-api-key.

Autenticação Simples

Não utilizamos Bearer Token. Basta enviar sua API Key diretamente no header x-api-key.

1. Obtenha suas credenciais

Antes de começar, você precisa de:

• API Key: Sua chave de acesso única
• Base URL: https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com

Como obter credenciais

Entre em contato com nossa equipe comercial através do email: comercial@checktudo.com.br

2. Usando a API Key

Inclua sua chave no header x-api-key de todas as requisições (sem prefixo Bearer):

Exemplo cURL

curl -X POST "https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com/queries/integration/agregados" \
  -H "x-api-key: sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{"keys": {"licensePlate": "ABC1234"}}'

JavaScript

const response = await fetch('https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com/queries/integration/agregados', {
  method: 'POST',
  headers: {
    'x-api-key': 'sua_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    keys: { licensePlate: 'ABC1234' }
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.post(
    'https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com/queries/integration/agregados',
    headers={
        'x-api-key': 'sua_api_key',
        'Content-Type': 'application/json',
    },
    json={
        'keys': {'licensePlate': 'ABC1234'}
    }
)

data = response.json()
print(data)

PHP

<?php
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com/queries/integration/agregados',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'x-api-key: sua_api_key',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'keys' => ['licensePlate' => 'ABC1234']
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "sua_api_key");

var content = new StringContent(
    JsonSerializer.Serialize(new { keys = new { licensePlate = "ABC1234" } }),
    Encoding.UTF8,
    "application/json"
);

var response = await client.PostAsync(
    "https://pwe6qnayhg.execute-api.sa-east-1.amazonaws.com/queries/integration/agregados",
    content
);

var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

Permissões

Ao criar uma API Key, você pode definir quais operações ela pode realizar:

Permissão
Realizar consultas veiculares
Visualizar consultas realizadas
Emitir CRLV Digital
Realizar consultas em lote

Erros de Autenticação

Código	Erro	Descrição
401	INVALID_API_KEY	Chave de API inválida ou não encontrada
401	EXPIRED_API_KEY	Chave de API expirada
403	INSUFFICIENT_PERMISSIONS	Chave não tem permissão para este recurso
429	RATE_LIMIT_EXCEEDED	Limite de requisições excedido

Exemplo de erro

{
  "statusCode": 401,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "A API Key fornecida é inválida ou não existe."
  }
}

Boas Práticas

1. Use variáveis de ambiente para armazenar suas chaves
2. Crie chaves específicas para cada ambiente (dev, staging, prod)
3. Revogue chaves comprometidas imediatamente
4. Monitore o uso através do painel de controle

Próximos Passos

• Tratamento de Erros
• Fazer sua Primeira Consulta
• Explorar Consultas Veiculares