Leia antes:
../conectores.md(mapa de estados) efichas.md(índice das fichas).
What it is#
Extracts sales, products, services and customers from the Conta Azul API and loads into the Bronze layer.
Supported ingestion modes:
- We fetch — We fetch the data from your source.
What it's for#
Bring Conta Azul data into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language question wizard.
When to use / when not to use#
Use when you need to consolidate this source into the datalake on a scheduled basis, with isolation per workspace.
Remember that the first run with a real credential is followed by our team before the connector is fully released.
Plan and permissions#
- Plan: core product (connectors are part of all plans; the limit is the number of sources allowed by the plan).
- Access: requires an active workspace — if the subscription is overdue, suspended, or canceled, the run is blocked.
- Shutdown: the ingestion run can be temporarily turned off (maintenance or incident). When that happens, the screen indicates the resource is currently unavailable.
Prerequisites#
- A Conta Azul account with access to the data you want to ingest.
- Create an application at developers.contaazul.com, authorize it in your Conta Azul account (OAuth flow) and provide the generated Client ID, Client Secret and refresh token. Secrets are encrypted (AES-256-GCM) and never shown again. If the authorization expires, simply reconnect — the source and history are preserved.
Credentials#
Authentication method: OAuth 2.0 (client id/secret + refresh token). All secrets are encrypted (AES-256-GCM) and never shown again. If authorization expires, just reconnect — the source and history are preserved.
Sensitive fields. They are encrypted (AES-256-GCM) and never remain in the connection config, in the pipeline definition, in the export or in the DAG. By default the encrypted value is stored in the database; moving the credential for this connection to an external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.
- Client Secret (
clientSecret) - Refresh token (
refreshToken) — Issued during the application's OAuth authorization flow. If it expires or is revoked, reconnect the account — there is no need to recreate the source.
Secrets are never re-displayed and are redacted in all errors/logs (raw token, URL-encoded and in JSON).
Form fields#
| Campo | Rótulo | Tipo | Obrigatório | Observação |
|---|---|---|---|---|
clientId | Client ID | texto | sim | Gerado ao criar o aplicativo no portal do desenvolvedor Conta Azul (developers.contaazul.com). |
clientSecret 🔒 | Client Secret | senha/segredo | sim | segredo (cifrado; cofre externo opcional) |
refreshToken 🔒 | Refresh token | senha/segredo | sim | segredo (cifrado; cofre externo opcional); Emitido no fluxo de autorização OAuth do aplicativo. Se expirar ou for revogado, reconecte a conta — não é preciso recriar a fonte. |
Step by step#
- No menu Dados → Conexões, use Nova conexão.
- Escolha Conta Azul no catálogo.
- Preencha os campos do formulário (veja a tabela acima).
- Use Testar conexão. The result is shown broken down into Conectividade, Autenticação and Listagem/leitura — each with OK, Failed, Not applicable or Not tested. A capability with no test of its own for this connector shows as Not applicable, and Not applicable never counts as success.
- Use Salvar conexão. Salvar NÃO inicia ingestão nenhuma.
- No cartão da connection, use Montar extração (ou vá em Orquestração → Pipelines e use Conectar fonte). O pipeline aponta para a connection salva — a credencial não é copiada.
- Na revisão, Publicar (agenda desligada) cria a versão 1 sem executar nada. Depois, Ativar agenda e Executar agora são ações separadas.
Example — connection test#
Sample configuration (all values are fictitious; secrets appear masked):
# Exemplo sintético (valores fictícios — não são credenciais reais)
clientId = exemplo-client-id-ficticio
clientSecret = •••••• (cifrado — nunca exibido)
refreshToken = •••••• (cifrado — nunca exibido)Expected result#
The Testar conexão returns the list of discovered tables/resources. After the first load, rows appear in the Bronze layer of your workspace, ready for the pipeline.
Limits and costs#
- Pagination: hard ceiling per run (default 10,000 pages / 5,000,000 rows); anti-loop safeguard.
- SaaS load: default
batchSize5,000,maxRows200,000 per resource. - Estimated volume: ~0.5 GB/month (catalog estimate, not measurement).
- Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).
Security#
- Scope per workspace: each customer reads and writes only to their own datalake (
<prefix>_bronze/_silver/_gold); there is never leakage between workspaces. - Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being persisted. The external credential vault is optional and enabled per connection; without it, the encrypted value remains in the database. Changing the value here DOES NOT revoke the credential at the origin.
- Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
- Production does not mock: a path that would fall into a mock triggers the production guard (explicit failure instead of simulating success).
Common errors#
- Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or lacking required permission. Reconnect the source (the source and history are preserved; do not recreate the source).
- Rate limit (429) — the provider asked to wait. The extraction respects
Retry-Afterand retries; if repeated, wait and reduce the schedule frequency. - Resource not found — check the resource identifier (account, object, report) and the granted permissions.
- Pagination cursor stuck — the extraction stops when the API cursor does not advance (anti-loop safeguard). If this happens in consecutive runs, open a support ticket with the connector and resource information.
- Empty record path — the response arrived without records at the expected location. Check the selected resource and filters (period, account, status) before assuming there is no data.
Troubleshooting#
- Use Testar conexão to isolate credential/network issues before scheduling.
- Monitor runs in the connector observability (error rate, p50/p95, freshness).
- A schema change at the source is flagged by schema drift (new column = info; removed column/type changed = attention).
Related#
../conectores.md— connector catalog by state../ingestao-incremental-backfill.md— full, incremental by watermark, backfill and checkpoint../pipeline-medalhao.md— Bronze/Silver/Gold layers and quality../agendamento-retry-dlq.md— scheduling, retry/backoff and DLQ../custo-limites-seguranca.md— cost, limits and security per workspace
Last revision: 2026-10-04. Record automatically generated from the product connector catalog.