Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

BrasilAPI — connector

Reads national holidays by year, the list of banks (ISPB and Compe code) and official rates (Selic, CDI, IPCA) from BrasilAPI and loads them into the Bronze layer.

On this page (15)

Leia antes: ../conectores.md (map of states) and fichas.md (index of connector sheets).


What it is#

Reads national holidays by year, the list of banks (ISPB and Compe code) and official rates (Selic, CDI, IPCA) from BrasilAPI and loads them into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — We fetch the data from its source.

What it's for#

Bring BrasilAPI 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 workspace isolation.

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 of the product (connectors are part of all plans; the limit is the number of sources allowed by the plan).
  • Access: requires an active workspace — with subscription past due, suspended or canceled, the run is blocked.
  • Shutdown: the ingestion run can be turned off temporarily (maintenance or incident). When this happens, the screen indicates the resource is unavailable at the moment.

Prerequisites#

  • No credentials: the data is public.
  • No credential required: BrasilAPI is public and free. Provide only the year for national holidays; banks (ISPB, Compe code) and official rates (Selic, CDI, IPCA) do not depend on parameters.

Credentials#

Authentication method: No credential — public data.

This connector does not require its own secrets (upload mode / no credential on the platform).

Secrets are never re-displayed and go through redaction in any error/log (raw token, URL-encoded and in JSON).

Form fields#

FieldLabelTypeRequiredNotes
anoYear of the holidaystextyesdefault: 2026; Four-digit year for the national holidays table.

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose BrasilAPI from the catalog.
  3. Fill in the form fields (see table above).
  4. 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.
  5. Use Salvar conexão. Saving DOES NOT start any ingestion.
  6. 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.
  7. In review, Publicar (agenda desligada) creates version 1 without running anything. Then, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Example configuration (all values are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
ano = 2026

Expected result#

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 guard.
  • SaaS load: default batchSize 5,000, maxRows 200,000 per resource.
  • Estimated volume: ~0.01 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Workspace scope: 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 stored. The external credential vault is optional and attached by connection; without it, the encrypted value stays in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: all error/logs go through secret redaction (raw, URL-encoded and in JSON).
  • Production does not mock: a path that would hit a mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Credential refused (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).
  • Rate limit (429) — the provider asked to wait. The extraction respects Retry-After and retries; if it repeats, 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 ends when the API cursor does not advance (anti-loop guard). If it happens on successive runs, open a support ticket informing the connector and the resource.
  • Empty record path — the response arrived without records where expected. 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 observability per connector (error rate, p50/p95, freshness).
  • A schema change at the source is signaled by schema drift (new column = info; removed column/type changed = attention).

Related#


Last reviewed: 2026-10-04. Sheet automatically generated from the product connector catalog.

Related links