Skip to content

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

Updated on 2026-10-04

Nuvemshop — connector

Reads orders, products and customers from Nuvemshop API v1 (following the pagination Link header) and loads into the Bronze layer.

On this page (15)

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


What it is#

Reads orders, products and customers from Nuvemshop API v1 (following the pagination Link header) and loads into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — Nós buscamos os dados na sua fonte.

What it's for#

Bring Nuvemshop 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 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 included in all plans; the limit is the number of sources of the plan).
  • Access: requires an active workspace — with subscription overdue, suspended or canceled, the run is blocked.
  • Disablement: the ingestion run can be temporarily turned off (maintenance or incident). When this happens, the UI indicates the resource is currently unavailable.

Prerequisites#

  • A Nuvemshop account with access to the data you want to ingest.
  • Create an app in the Nuvemshop partner portal, install it in your store and copy the store ID (store_id) and the access token (access_token) returned at authorization. The token does not expire while the app is installed; it is encrypted (AES-256-GCM) and never shown again.

Credentials#

Authentication method: Access token pasted by you. It is encrypted (AES-256-GCM) and never shown again, nor appears in logs or error messages.

Sensitive fields. They are encrypted (AES-256-GCM) and never remain in the connection config, in the pipeline definition, in exports or in the DAG. By default the encrypted value is stored in the database; moving the credential of this connection to the external credential vault is an explicit choice, made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Token de acesso (tokenAcesso) — access_token returned when installing the app. If the app is uninstalled, Nuvemshop invalidates the token — reinstall and update here.

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

Form fields#

FieldLabelTypeRequiredNotes
storeIdStore IDtextyesThe user_id/store_id returned when authorizing the app (also visible in the partner portal).
tokenAcesso 🔒Access tokenpassword/secretyessecret (encrypted; external vault optional); access_token returned when installing the app. If the app is uninstalled, Nuvemshop invalidates the token — reinstall and update here.

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Nuvemshop 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. 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. After that, Ativar agenda and Executar agora are separate actions.

Example — connection test#

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

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
storeId = <storeId>
tokenAcesso = •••••• (cifrado — nunca exibido)

Expected result#

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); includes an 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 (chargeable).

Security#

  • Workspace scope: each customer reads and writes only to their own datalake (<prefixo>_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 origin.
  • Redaction: every error/log is passed through secret redaction (raw, URL-encoded and in JSON).
  • Production does not 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 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 this happens in consecutive runs, open a support ticket informing the connector and the resource.
  • Empty records 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 problems 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 revision: 2026-10-04. Sheet automatically generated from the product connector catalog.

Related links