API de Integração

Integre nossos serviços de diários oficiais diretamente em seus sistemas com nossa API robusta, bem documentada e de alta performance

Recursos

Tudo que você precisa

Uma API completa e robusta para integração com diários oficiais.

API REST Completa

Interface REST completa e intuitiva para integração com seus sistemas existentes.

Documentação Interativa

Documentação detalhada com exemplos práticos, SDKs e playground interativo.

Notificações em Tempo Real

Receba notificações instantâneas sobre publicações e atualizações nos diários.

Segurança Avançada

API Keys, OAuth2, rate limiting e criptografia end-to-end para máxima segurança.

Alta Performance

Infraestrutura otimizada para garantir resposta rápida e disponibilidade 99.9%.

SDKs Múltiplas Linguagens

SDKs oficiais para JavaScript, Python, PHP, Java e outras linguagens populares.

Endpoints

Principais Endpoints

Endpoints RESTful para todas as operações com diários oficiais.

GET/api/v1/diarios

Buscar diários oficiais com filtros avançados

POST/api/v1/diarios

Publicar novo diário oficial

GET/api/v1/alertas

Configurar e gerenciar alertas personalizados

POST/api/v1/webhooks

Registrar webhooks para notificações

Exemplos

Exemplos de Código

Exemplos práticos em múltiplas linguagens para você começar rapidamente.

JavaScript

// Instalar SDK
npm install @diarios-oficiais/sdk

// Configurar cliente
import { DiariosAPI } from '@diarios-oficiais/sdk';

const api = new DiariosAPI({
  apiKey: 'sua-api-key-aqui',
  baseURL: 'https://api.diariosoficiais.com.br'
});

// Buscar diarios
const diarios = await api.diarios.buscar({
  data: '2024-01-15',
  orgao: 'prefeitura',
  palavrasChave: ['licitacao', 'concurso']
});

console.log(diarios);

Python

# Instalar via pip
pip install diarios-oficiais-sdk

# Configurar cliente
from diarios_oficiais import DiariosAPI

api = DiariosAPI(
    api_key='sua-api-key-aqui',
    base_url='https://api.diariosoficiais.com.br'
)

# Buscar diarios
diarios = api.diarios.buscar(
    data='2024-01-15',
    orgao='prefeitura',
    palavras_chave=['licitacao', 'concurso']
)

print(diarios)

PHP

<?php
// Instalar via Composer
composer require diarios-oficiais/sdk

// Configurar cliente
use DiariosOficiais\SDK\DiariosAPI;

$api = new DiariosAPI([
    'api_key' => 'sua-api-key-aqui',
    'base_url' => 'https://api.diariosoficiais.com.br'
]);

// Buscar diarios
$diarios = $api->diarios->buscar([
    'data' => '2024-01-15',
    'orgao' => 'prefeitura',
    'palavras_chave' => ['licitacao', 'concurso']
]);

var_dump($diarios);
?>

Começando

Primeiros Passos

Comece a integrar nossa API em menos de 5 minutos.

1. Crie sua Conta

Registre-se gratuitamente e obtenha acesso imediato a nossa API.

POST https://api.diariosoficiais.com.br/v1/auth/register

2. Obtenha sua API Key

Acesse seu dashboard e gere sua chave de API personalizada.

GET https://api.diariosoficiais.com.br/v1/auth/keys

Autenticação

Segurança e Acesso

Nossa API utiliza autenticação baseada em API Keys para máxima segurança.

API Key Authentication

Inclua sua API Key no header de todas as requisicoes.

curl -X GET \
  'https://api.diariosoficiais.com.br/v1/diarios' \
  -H 'Authorization: Bearer sua-api-key-aqui' \
  -H 'Content-Type: application/json'

Rate Limiting

Limites de requisicoes por minuto baseados no seu plano.

Plano Gratuito100 req/min
Plano Pro1,000 req/min
Plano Enterprise10,000 req/min

Ambientes

Desenvolvimento e Producao

Diferentes ambientes para desenvolvimento, teste e producao.

Produção

Ambiente estável para aplicações em produção.

https://api.diariosoficiais.com.br

Desenvolvimento

Ambiente de teste para desenvolvimento e validação.

https://dev-api.diariosoficiais.com.br

Staging

Ambiente de pré-produção para testes finais.

https://staging-api.diariosoficiais.com.br

Referência da API

Documentação Completa

Todos os endpoints, parâmetros e exemplos de uso da nossa API.

Diarios Oficiais

GET/v1/diarios

Lista todos os diarios oficiais com filtros opcionais.

GET /v1/diarios?data=2024-01-15&orgao=prefeitura&palavras_chave=licitacao

Resposta:
{
  "data": [
    {
      "id": "12345",
      "titulo": "Edital de Licitacao",
      "orgao": "Prefeitura Municipal",
      "data_publicacao": "2024-01-15",
      "conteudo": "Conteudo do diario...",
      "url": "https://diario.prefeitura.com.br/12345"
    }
  ],
  "total": 1,
  "pagina": 1,
  "limite": 50
}
POST/v1/diarios

Publica um novo diario oficial.

POST /v1/diarios
Content-Type: application/json
Authorization: Bearer sua-api-key

{
  "titulo": "Edital de Licitacao",
  "conteudo": "Conteudo do diario...",
  "orgao": "Prefeitura Municipal",
  "data_publicacao": "2024-01-15"
}

Alertas

GET/v1/alertas

Lista todos os alertas configurados.

GET /v1/alertas

Resposta:
{
  "data": [
    {
      "id": "alert_123",
      "nome": "Licitacoes Prefeitura",
      "palavras_chave": ["licitacao", "edital"],
      "orgao": "prefeitura",
      "ativo": true,
      "criado_em": "2024-01-01T00:00:00Z"
    }
  ]
}
POST/v1/alertas

Cria um novo alerta personalizado.

POST /v1/alertas
Content-Type: application/json
Authorization: Bearer sua-api-key

{
  "nome": "Licitacoes Prefeitura",
  "palavras_chave": ["licitacao", "concurso"],
  "orgao": "prefeitura",
  "webhook_url": "https://seu-site.com/webhook"
}

Webhooks

Notificacoes em Tempo Real

Receba notificacoes instantaneas quando novos diarios forem publicados.

Configuração de Webhook

Configure seu endpoint para receber notificações automáticas.

POST /v1/webhooks
Content-Type: application/json
Authorization: Bearer sua-api-key

{
  "url": "https://seu-site.com/webhook",
  "eventos": ["diario.publicado", "diario.atualizado"],
  "filtros": {
    "orgao": "prefeitura",
    "palavras_chave": ["licitacao"]
  }
}

• URL deve ser HTTPS

• Deve responder com status 200

• Timeout de 30 segundos

Estrutura da Notificação

Estrutura da notificação enviada para seu endpoint.

{
  "evento": "diario.publicado",
  "timestamp": "2024-01-15T10:30:00Z",
  "dados": {
    "id": "12345",
    "titulo": "Edital de Licitacao",
    "orgao": "Prefeitura Municipal",
    "data_publicacao": "2024-01-15",
    "url": "https://diario.prefeitura.com.br/12345"
  }
}

Códigos de Erro

Debug Eficiente

Códigos de status HTTP e mensagens de erro para debug eficiente.

4xx - Erros do Cliente

400Bad Request
401Unauthorized
403Forbidden
404Not Found

5xx - Erros do Servidor

500Internal Server Error
502Bad Gateway
503Service Unavailable
504Gateway Timeout

2xx - Sucesso

200OK
201Created
204No Content

Exemplo de Resposta de Erro

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "O parâmetro 'data' é obrigatório",
    "details": {
      "field": "data",
      "expected": "YYYY-MM-DD"
    }
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "request_id": "req_123456789"
}

Estatísticas

Performance e Confiabilidade

Nossa infraestrutura garante alta disponibilidade e performance otimizada.

99.9%
Uptime
< 200ms
Latência Média
10,000+
Requisições/min
24/7
Suporte

Pronto para começar?

Obtenha sua API Key gratuita e comece a integrar em menos de 5 minutos.