Autenticação e API Keys

A API do Radar DOU utiliza autenticacao baseada em API Keys para garantir acesso seguro aos endpoints. Este guia explica como obter, configurar e utilizar suas credenciais de forma segura.

Visao Geral da Autenticacao

Todas as requisicoes a API do Radar DOU devem incluir uma API Key valida no header da requisicao. A autenticacao e feita atraves do header X-API-Key.

# Exemplo de requisicao autenticada
curl -X GET "https://radardou.com.br/api/v1/buscar?termo=licitacao" \
  -H "X-API-Key: sua_api_key_aqui" \
  -H "Content-Type: application/json"

Obtendo sua API Key

Para obter sua API Key, siga os passos abaixo:

1. Acesse o Dashboard: Faca login na sua conta do Radar DOU e navegue ate o painel de controle.
2. Va para API Keys: No menu lateral, clique em "Configuracoes" e depois em "API Keys".
3. Crie uma nova chave: Clique no botao "Criar Nova API Key" e forneca um nome descritivo para identificar o uso.
4. Copie e armazene: A chave sera exibida apenas uma vez. Copie-a e armazene em local seguro.

Formato da API Key

As API Keys do Radar DOU seguem um formato padronizado para facilitar a identificacao:

# Formato da API Key
rdou_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx  # Chave de producao
rdou_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxx  # Chave de teste/sandbox

• rdou_live_: Prefixo para chaves de producao com acesso total a API
• rdou_test_: Prefixo para chaves de teste, ideal para desenvolvimento

Usando a API Key nas Requisicoes

A API Key deve ser enviada no header X-API-Key de cada requisicao:

Exemplo em Python

import requests

API_KEY = "rdou_live_sua_chave_aqui"
BASE_URL = "https://radardou.com.br/api/v1"

headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json"
}

response = requests.get(
    f"{BASE_URL}/buscar",
    headers=headers,
    params={"termo": "contrato"}
)

print(response.json())

Exemplo em JavaScript

const API_KEY = "rdou_live_sua_chave_aqui";
const BASE_URL = "https://radardou.com.br/api/v1";

const response = await fetch(`${BASE_URL}/buscar?termo=contrato`, {
    method: "GET",
    headers: {
        "X-API-Key": API_KEY,
        "Content-Type": "application/json"
    }
});

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

Gerenciando suas API Keys

No painel de API Keys, voce pode realizar as seguintes acoes:

• Visualizar chaves ativas: Lista todas as API Keys criadas com data de criacao e ultimo uso
• Revogar chaves: Desative chaves que nao sao mais necessarias ou que foram comprometidas
• Monitorar uso: Acompanhe o numero de requisicoes feitas por cada chave
• Definir permissoes: Configure quais endpoints cada chave pode acessar

Boas Praticas de Seguranca

Configurando Variaveis de Ambiente

A forma mais segura de utilizar sua API Key e atraves de variaveis de ambiente:

Linux/macOS

# Adicione ao seu .bashrc ou .zshrc
export RADAR_DOU_API_KEY="rdou_live_sua_chave_aqui"

# Ou defina temporariamente
RADAR_DOU_API_KEY="rdou_live_sua_chave_aqui" python seu_script.py

Windows (PowerShell)

# Variavel temporaria
$env:RADAR_DOU_API_KEY = "rdou_live_sua_chave_aqui"

# Variavel permanente (usuario)
[Environment]::SetEnvironmentVariable("RADAR_DOU_API_KEY", "rdou_live_sua_chave_aqui", "User")

Arquivo .env (Node.js/Python)

# .env (adicione ao .gitignore!)
RADAR_DOU_API_KEY=rdou_live_sua_chave_aqui

Erros Comuns de Autenticacao

Proximos Passos

Agora que voce configurou sua autenticacao, explore os proximos topicos:

• Endpoints disponiveis: Conheca todos os endpoints da API
• Rate limits: Entenda os limites de requisicoes do seu plano
• Exemplos praticos: Veja implementacoes em Python e JavaScript