Skip to content

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

Updated on 2026-10-04

Omie ERP — connector

Extracts business tables (orders, products, financial) from the Omie ERP API and loads them into the Bronze layer.

On this page (15)

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


What it is#

Extracts business tables (orders, products, financial) from the Omie ERP API and loads them into the Bronze layer.

Supported ingestion modes:

  • We fetch — We fetch the data from your source.

What it's for#

Bring Omie ERP 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 in 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 temporarily turned off (maintenance or incident). When this happens, the screen indicates that the feature is currently unavailable.

Prerequisites#

  • An Omie ERP account with access to the data you want to ingest.
  • Generate the integration keys (App Key and App Secret) at developer.omie.com.br with your Omie account login and paste them below. The App Secret is encrypted (AES-256-GCM) and is never shown again.

Credentials#

Authentication method: Pair App Key / App Secret generated by you in the provider portal. The App Secret is encrypted (AES-256-GCM) and is never shown again.

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

  • App Secret (appSecret)

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

Form fields#

CampoRótuloTipoObrigatórioObservação
appKeyApp KeytextyesApplication identifier, generated together with the App Secret at the Omie developer portal.
appSecret 🔒App Secretpassword/secretyessecret (encrypted; external vault optional)

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Omie ERP 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 the review, Publicar (agenda desligada) creates version 1 without running anything. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Config example (all values are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
appKey = 1234567890123
appSecret = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, 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.5 GB/month (catalog estimate, not measured).
  • 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 (<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 stays in the database. Changing the value here DOES NOT revoke the credential at the origin.
  • Redaction: all error/log entries go 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 the necessary permission. Reconnect the source (the source and the 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.
  • Stuck pagination cursor — the extraction ends 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 records path — the response arrived without records in the expected location. Check the selected resource and the 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/changed type column = attention).

Related#


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

Related links