Skip to content

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

Updated on 2026-10-04

Ploomes — connector

Reads deals, contacts, products and tasks from Ploomes' OData API and loads them into the Bronze layer.

On this page (15)

Leia antes: ../conectores.md (state map) and fichas.md (index of the guides).


What it is#

Reads deals, contacts, products and tasks from Ploomes' OData API 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 Ploomes data into your datalake and make it available to the Bronze/Silver/Gold layers, to BI models and to 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 schedule, 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 — with overdue, suspended or cancelled subscription, the run is blocked.
  • Shutdown: ingestion runs may be temporarily switched off (maintenance or incident). When this happens, the screen indicates the resource is unavailable at the moment.

Prerequisites#

  • A Ploomes account with access to the data you want to ingest.
  • In Ploomes, go to Administração → Usuários, open the integration user and copy the API User-Key. Paste it below; the key is encrypted (AES-256-GCM) and is never shown again. Use a user with read permission on deals, contacts, products and tasks.

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 stored in the database; moving the credential of this connection to an external credential vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Chave de usuário (User-Key) (chaveUsuario) — API key of the integration user (Administration → Users).

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

Form fields#

CampoRótuloTipoObrigatórioObservação
chaveUsuario 🔒Chave de usuário (User-Key)password/secretyessecret (encrypted; external vault optional); API key of the integration user (Administration → Users).

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Ploomes in the catalog.
  3. Fill 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. 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 executing 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)
chaveUsuario = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, the 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 batchSize 5,000, maxRows 200,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#

  • Scope by workspace: each customer reads and writes only in 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 is stored in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
  • Production does not mock: a path that would go to 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-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 informing 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 are 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#


Last review: 2026-10-04. Guide automatically generated from the product connector catalog.

Related links