Read before:
../conectores.md(state map) andfichas.md(index of the sheets).
What it is#
Reads invoices, subscriptions, customers and transactions from Vindi API v1 and loads them into the Bronze layer.
Supported ingestion modes:
- We fetch — We fetch the data from your source.
What it's for#
Bring Vindi 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 by 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 — if the subscription is overdue, suspended or cancelled, runs are blocked.
- Shutdown: ingestion runs can be temporarily turned off (maintenance or incident). When that happens, the UI indicates the resource is unavailable at the moment.
Prerequisites#
- A Vindi account with access to the data you want to ingest.
- In Vindi, go to Settings → API Keys and generate a key (preferably read-only). Paste it below; the key is encrypted (AES-256-GCM) and is never shown again. To validate without touching production, choose the Sandbox environment (key generated in sandbox-app).
Credentials#
Authentication method: Username and password (or key and secret) using Basic authentication.
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 the credential from this connection to an external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.
- API Key (
chaveApi) — Vindi API v1 key (Settings → API Keys). Sent as the HTTP Basic user with an empty password.
Secrets are never re-displayed and go through redaction on every error/log (raw token, URL-encoded and in JSON).
Form fields#
| Field | Label | Type | Required | Notes |
|---|---|---|---|---|
ambiente | Environment | selection | no | default: producao; options: producao / sandbox |
chaveApi 🔒 | Chave da API | password/secret | yes | secret (encrypted; external vault optional); Vindi API v1 key (Settings → API Keys). Sent as the HTTP Basic user with an empty password. |
Step by step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose Vindi from the catalog.
- Fill the form fields (see table above).
- Use Testar conexão. The result is shown separately as Network (server reach), Authentication (user and password) and Read (list tables) — each with OK, Failed, Not applicable or Not tested.
- 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. After that, Ativar agenda and Executar agora are separate actions.
Example — connection test#
Example configuration (all values are fictitious; secrets are masked):
# Exemplo sintético (valores fictícios — não são credenciais reais)
ambiente = producao
chaveApi = •••••• (cifrado — nunca exibido)Expected result#
The Testar conexão returns the list of discovered tables/resources. After the first load, rows appear in your workspace's Bronze layer, 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: 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 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: every error/log passes 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 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 successive runs, open a support ticket specifying 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 runs in the connector observability (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#
../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 revision: 2026-10-04. Sheet automatically generated from the product's connector catalog.