Read before:
../conectores.md(state map) andfichas.md(index of fichas).
What it is#
Reads charges (boleto, Pix, card), customers and subscriptions from the Asaas API v3 and loads them into the Bronze layer.
Supported ingestion modes:
- Nós buscamos — Nós buscamos os dados na sua fonte.
What it's for#
Bring Asaas data into your datalake and make it available to 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 in the plan).
- Access: requires an active workspace — with the subscription overdue, suspended or cancelled, the run is blocked.
- Shutdown: the ingestion run can be temporarily disabled (maintenance or incident). When this happens, the UI indicates the resource is currently unavailable.
Prerequisites#
- An Asaas account with access to the data you want to ingest.
- In Asaas, go to Integrations → API Key and generate a key (it starts with $aact_). Paste it below; the key is encrypted (AES-256-GCM) and is never shown again. To test without touching production, choose the Sandbox environment.
Credentials#
Authentication method: API Key generated in the provider's panel, sent in header/parameter.
Sensitive fields. They are encrypted (AES-256-GCM) and are never stored in the config of the connection, in the pipeline definition, in the export or in the DAG. By default the encrypted value is kept in the database; moving this connection's credential to an external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.
- API Key (
apiKey) — Access key for Asaas API v3 (Integrations → API Key).
Secrets are never re-displayed and are redacted in every error/log (raw token, URL-encoded and in JSON).
Form fields#
| Campo | Rótulo | Tipo | Obrigatório | Observação |
|---|---|---|---|---|
ambiente | Environment | selection | no | default: producao; options: producao / sandbox |
apiKey 🔒 | API Key | password/secret | yes | secret (encrypted; external vault optional); Access key for Asaas API v3 (Integrations → API Key). |
Step by step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose Asaas in the catalog.
- Fill the form fields (see the table above).
- 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. Saving does NOT start any ingestion.
- On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
- In the review, Publicar (agenda desligada) creates version 1 without running anything. Then, Ativar agenda and Executar agora are separate actions.
Example — connection test#
Configuration example (all values are fictitious; secrets appear masked):
# Exemplo sintético (valores fictícios — não são credenciais reais)
ambiente = producao
apiKey = •••••• (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 cap per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
- SaaS load: default
batchSize5,000,maxRows200,000 per resource. - Estimated volume: ~0.3 GB/month (catalog estimate, not measurement).
- Cost: 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 written. The external credential vault is optional and enabled per connection; without it, the encrypted value stays 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 doesn't fake: a path that would fall into 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 necessary permission. Reconnect the source (the source and history are preserved; do not recreate the source).
- Request limit (429) — the provider asked to wait. Extraction respects
Retry-Afterand retries; if it repeats, wait and reduce the schedule frequency. - Resource not found — check the resource identifier (account, object, report) and the permissions granted.
- Pagination cursor stuck — extraction stops when the API cursor does not advance (anti-loop guard). If it happens in consecutive runs, open a support ticket indicating the connector and the resource.
- Empty record path — the response arrived without records in the expected place. 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 the runs in connector observability (error rate, p50/p95, freshness).
- A schema change at the source is signaled by the 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, caps and workspace security
Last review: 2026-10-04. Sheet automatically generated from the product connector catalog.