A API de consulta REST (
/api/v1) está em acesso antecipado e ainda não está aberta para uso externo. O código existe e o contrato abaixo é o do comportamento atual. Para consumo externo agora, use o feed OData.
Acesso antecipado
Este contrato é documentado para planejamento e transparência. Não construa integrações críticas sobre a API REST enquanto ela não for liberada. Para ler tabelas hoje, prefira o OData.
Lista as tabelas dos marts publicados (datasets *_gold e *_silver) do workspace resolvido pela chave de API. Somente leitura, escopado ao workspace.
Resumo#
| Método · rota | GET /api/v1/tables |
| Base | https://ingestia.io |
| Auth | Chave de API (Authorization: Bearer ing_live_… ou ?api_key=) |
| Papel (RBAC) | exportação de dados (member+); chave de dados = owner |
| Custo | R$ 0 (listar catálogo não dispara job pago) |
| Estados | 200 · 401 · 403 · 429 · 402 · 503 |
Parâmetros#
Nenhum parâmetro de query. Também responde OPTIONS (pré-flight CORS) com 204.
Cabeçalhos de resposta#
X-Ingestia-Access-Scope: workspace(a chave lê o workspace inteiro).Content-Type: application/json; charset=utf-8.
Exemplo#
curl -H "Authorization: Bearer ing_live_EXEMPLO" \
https://ingestia.io/api/v1/tablesconst res = await fetch("https://ingestia.io/api/v1/tables", {
headers: { Authorization: "Bearer ing_live_EXEMPLO" },
});
const tabelas = await res.json();import requests
res = requests.get(
"https://ingestia.io/api/v1/tables",
headers={"Authorization": "Bearer ing_live_EXEMPLO"},
)
tabelas = res.json()Resposta 200#
[
{
"dataset": "prd_aurora_gold",
"table": "vendas",
"layer": "gold",
"columns": [
{ "name": "data", "type": "DATE" },
{ "name": "total", "type": "NUMERIC" }
]
}
]Sem datalake provisionado (demo), a rota devolve um catálogo claramente simulado para validar a integração — nunca finge dados reais.
Erros#
| Código | Quando |
|---|---|
401 | chave ausente/inválida/revogada |
403 | papel/escopo insuficiente (ex.: service principal viewer) |
429 | estourou o rate limit (traz Retry-After) |
402 | workspace inadimplente/suspenso |
503 | limitador indisponível (fail-closed) ou datalake não provisionado |
Formato: { "error": "mensagem em português" }. Catálogo completo em
Erros e limites.
Segurança#
- Só expõe marts publicados (gold/silver) — nunca a camada bronze.
- Colunas marcadas como PII não aparecem no catálogo.
- Escopo por workspace: a chave nunca resolve outro cliente.
Relacionados#
Última revisão: 2026-09-08.