Skip to content

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

Updated on 2026-10-04

Loja Integrada — connector

Reads orders (with status and customer), products and customers from the Loja Integrada API and loads them into the Bronze layer.

On this page (15)

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


What it is#

Reads orders (with status and customer), products and customers from the Loja Integrada API and loads them into the Bronze layer.

Supported ingestion modes:

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

What it's for#

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

Prerequisites#

  • A Loja Integrada account with access to the data you want to ingest.
  • In the Loja Integrada dashboard (plan with API access), go to Configurações → API and copy the Store API Key; the Application Key is for the integrator app. Both are encrypted (AES-256-GCM) and are never shown again.

Credentials#

Authentication method: API Key generated in the provider panel, sent in header/parameter.

Sensitive fields. They are encrypted (AES-256-GCM) and are never stored 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 an external credential vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • API Key (chaveApi) — Store key (parameter chave_api).
  • Application Key (chaveAplicacao) — Integrator application key (parameter chave_aplicacao).

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

Form fields#

CampoRótuloTipoObrigatórioObservação
chaveApi 🔒API Keypassword/secretyessecret (encrypted; external vault optional); Store key (parameter chave_api).
chaveAplicacao 🔒Application Keypassword/secretyessecret (encrypted; external vault optional); Integrator application key (parameter chave_aplicacao).

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Loja Integrada 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 running anything. After that, 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)
chaveApi = •••••• (cifrado — nunca exibido)
chaveAplicacao = •••••• (cifrado — nunca exibido)

Expected result#

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.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#

  • 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 persisted. The external credential vault is optional and linked per 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/log output is passed through secret redaction (raw, URL-encoded and in JSON).
  • No mocking in production: a path that would hit a mock triggers the production guard (explicit failure instead of simulated success).

Common errors#

  • Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or lacks 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 stating the connector and the resource.
  • Empty record 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 connection 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. Card automatically generated from the product connector catalog.

Related links