Skip to content

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

Updated on 2026-10-04

Granatum — connector

Reads financial entries, categories and accounts from Granatum API v1 and loads them into the Bronze layer.

On this page (15)

Read before: ../conectores.md (state map) and fichas.md (index of sheets).


What it is#

Reads financial entries, categories and accounts from Granatum API v1 and loads them into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — We pull the data from your source.

What it's for#

Bring Granatum 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 of the product (connectors are part of all plans; the limit is the number of sources in the plan).
  • Access: requires an active workspace — if the subscription is overdue, suspended or cancelled, the run is blocked.
  • Disabling: the ingestion run can be turned off temporarily (maintenance or incident). When that happens, the UI indicates the feature is currently unavailable.

Prerequisites#

  • A Granatum account with access to the data you want to ingest.
  • In Granatum, go to Settings → Integrations (API) and generate an access token. Paste it below; the token is encrypted (AES-256-GCM) and never shown again. It is sent as access_token in the query string, as required by the API.

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 connection config, the pipeline definition, the export or the DAG. By default the encrypted value is kept in the database; moving this connection's credential to the external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Access token (tokenAcesso) — API v1 token (Settings → Integrations). Sent as access_token in the query string.

Secrets are never re-displayed and are redacted in every error/log (raw, URL-encoded and in JSON).

Form fields#

FieldLabelTypeRequiredNote
tokenAcesso 🔒Access tokenpassword/secretyessecret (encrypted; external vault optional); API v1 token (Settings → Integrations). Sent as access_token in the query string.

Step by step#

  1. In the Dados → Conexões menu, use Nova conexão.
  2. Choose Granatum in the catalog.
  3. Fill in the form fields (see the 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. Save 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 the review, Publicar (agenda desligada) creates version 1 without running anything. Afterwards, 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)
tokenAcesso = •••••• (cifrado — nunca exibido)

Expected result#

Testar conexão returns the list of discovered tables/resources. After the first load, the 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.2 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 by 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. Replacing the value here DOES NOT revoke the credential at the source.
  • Redaction: every error/log goes through secret redaction (raw, URL-encoded and in JSON).
  • Production does not mock: 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 the necessary permission. Reconnect the source (the source and its 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 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 records path — the response arrived without records in 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 change = attention).

Related#


Last review: 2026-10-04. Sheet automatically generated from the product's connector catalog.

Related links