Pular para o conteúdo

    Para desenvolvedores

    API DataGateway. Todas as consultas.

    Documentação completa para integração. Consulte dados, gerencie créditos e automatize seus processos com uma API REST autenticada por chave.
    Começar

    Início rápido

    1. 1. Obtenha sua API Key

      Solicite sua chave de acesso ao administrador.

    2. 2. Explore o catálogo

      GET /catalog para ver todos os produtos e preços.

    3. 3. Faça consultas

      POST /query com o product_key e parâmetros.

    Base URL

    base url
    https://prerender.invalid/functions/v1/api-gateway

    Autenticação

    Todas as requisições devem incluir o header x-api-key com sua chave de acesso.

    curl
    curl -H "x-api-key: SUA_CHAVE_AQUI" \
  https://prerender.invalid/functions/v1/api-gateway/balance

    Endpoints

    GET/catalog

    Retorna o catálogo completo de produtos disponíveis, com campos de entrada, preços e metadados.

    Autenticação: x-api-key

    response · json
    {
  "client": { "name": "Minha Empresa", "balance": 500.00 },
  "total_products": 42,
  "categories": ["CPF/CNPJ", "Veículos", "Processos"],
  "products": [
    {
      "product_key": "acoes-processos-judiciais",
      "name": "Processos Judiciais",
      "description": "Consulta de ações e processos judiciais por CPF ou CNPJ",
      "category": "Consultas",
      "price_per_query": 2.50,
      "currency": "BRL",
      "input_fields": [
        { "name": "cpf", "label": "CPF", "type": "text", "required": false, "mask": "999.999.999-99" },
        { "name": "cnpj", "label": "CNPJ", "type": "text", "required": false, "mask": "99.999.999/9999-99" }
      ],
      "delivers": ["CNJ", "Classe processual", "Partes", "Movimentações", "Status processual"]
    }
  ],
  "endpoints": { ... }
}

    GET/balance

    Consulta o saldo de créditos do cliente.

    Autenticação: x-api-key

    response · json
    {
  "balance": 350.00,
  "name": "Minha Empresa"
}

    POST/query

    Executa uma consulta em um produto. Para Processos Judiciais, envie CPF ou CNPJ. A consulta é processada de forma assíncrona.

    Autenticação: x-api-key

    request body · json
    {
  "product_key": "acoes-processos-judiciais",
  "params": {
    "cpf": "000.000.000-00"
  }
}
    response · json
    {
  "job_id": "uuid-do-job",
  "product_key": "acoes-processos-judiciais",
  "status": "processing",
  "cost": 2.50,
  "balance_after": 347.50,
  "response_time_ms": 45,
  "message": "Query submitted. Poll /status?job_id=<id> for results."
}

    GET/status?job_id=<id>

    Verifica o status e resultado de uma consulta enviada.

    Autenticação: x-api-key

    response · json
    {
  "job_id": "uuid-do-job",
  "product_key": "acoes-processos-judiciais",
  "status": "completed",
  "result": {
    "response": {
      "data": {
        "dados": {
          "acoesProcessos": {
            "acoes": {
              "processos": [
                {
                  "numeroProcessoUnico": "10000000020234000000",
                  "tribunal": "TJ-FICT",
                  "orgaoJulgador": "1ª VARA FICTÍCIA",
                  "statusPj": { "statusProcesso": "EM TRAMITAÇÃO" }
                }
              ]
            }
          }
        }
      }
    }
  },
  "created_at": "2026-03-12T10:00:00Z",
  "completed_at": "2026-03-12T10:00:03Z"
}

    POST/buy-credits

    Gera uma cobrança via PIX ou Boleto para compra de créditos.

    Autenticação: x-api-key

    request body · json
    {
  "amount": 100,
  "method": "PIX"
}
    response · json
    {
  "purchase_id": "uuid",
  "payment_id": "pay_xxx",
  "method": "PIX",
  "amount": 100,
  "credits": 100,
  "status": "PENDING",
  "pix_payload": "00020126...",
  "pix_qr_code_base64": "data:image/png;base64,...",
  "pix_expiration_date": "2026-03-13T15:00:00Z"
}

    GET/purchase-status?purchase_id=<id>

    Verifica o status de um pagamento de créditos.

    Autenticação: x-api-key

    response · json
    {
  "id": "uuid",
  "status": "RECEIVED",
  "amount_reais": 100,
  "credits": 100,
  "method": "PIX",
  "created_at": "2026-03-12T10:00:00Z",
  "received_at": "2026-03-12T10:05:00Z"
}

    Códigos de erro

    Códigos de erro HTTP da API
    CódigoDescrição
    401API key ausente ou inválida
    402Saldo insuficiente para a consulta
    403API key suspensa ou IP não autorizado
    404Produto não encontrado ou endpoint inválido
    400Parâmetros inválidos na requisição
    500Erro interno do servidor

    Fluxo de consulta

    1. 1POST /query → recebe job_id
    2. 2GET /status?job_id=xxx
    3. 3Se status='processing', aguardar
    4. 4Se status='completed', resultado disponível
    # Exemplo completo em Python
import requests, time

API_KEY = "sua_chave"
BASE = "https://prerender.invalid/functions/v1/api-gateway"
headers = {"x-api-key": API_KEY}

# 1. Enviar consulta
r = requests.post(f"{BASE}/query", json={
    "product_key": "cpf_receita_federal",
    "params": {"cpf": "123.456.789-00"}
}, headers=headers)
job_id = r.json()["job_id"]

# 2. Polling até completar
while True:
    status = requests.get(f"{BASE}/status?job_id={job_id}", headers=headers).json()
    if status["status"] in ("completed", "error"):
        break
    time.sleep(2)

print(status["result"])

    Preço por consulta

    Não há planos fixos. Cada consulta tem o seu próprio preço (price_per_query emGET /catalog), definido para a sua conta, e o valor é debitado do saldo de créditos a cada consulta (cost ebalance_after na resposta de POST /query). Créditos são comprados por PIX ou boleto e liberados após a confirmação do pagamento.

    Entenda o preço por consulta

    DataGateway API — Documentação para clientesLeve a documentação completa em PDF.