Leia antes:
../conectores.md(state map) andfichas.md(index of fichas).
⚠️ Notice — Roadmap (not available)#
This connector is not implemented: configuration and run attempts are rejected by the product (nothing pretends success).
The Protheus REST API depends on the release and customization installed at each customer; there is no stable public format for a generic connector.
The remainder of this page describes the planned specification (fields and connection shape), not an active feature.
What it is#
Planned connector: reading orders, products and financials from TOTVS Protheus via the REST API does not exist yet — today data enters via scheduled exports (CSV/JSON) to the landing area.
Supported ingestion modes:
- We pull — We pull the data from your source.
Purpose#
Bring data from TOTVS Protheus 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 in the datalake on a scheduled basis, with workspace isolation.
Do not use for production today: the connector is on the Roadmap. Meanwhile, for files use the "Você deposita" mode (upload files to the landing).
Plan and permissions#
- Plan: core of the product (connectors are part of all plans; the limit is the number of sources allowed by the plan).
- Access: requires an active workspace — with the subscription overdue, suspended or cancelled, runs are blocked.
- Shutdown: ingestion runs can be temporarily turned off (maintenance or incident). When that happens, the screen reports the feature is unavailable at the moment.
Prerequisites#
- A TOTVS Protheus account with access to the data you want to ingest.
- When the connector exists, the connection will use the Protheus REST API (REST service enabled on the appserver) with an integration user. Today data enters via scheduled exports (CSV/JSON) to the landing area of your environment.
Credentials#
Authentication method: API Key generated in the provider panel, sent in a header/parameter.
This connector does not require its own secrets (upload mode / no credential stored on the platform).
Secrets are never re-displayed and go through redaction in every error/log (raw token, URL-encoded and in JSON).
Form fields#
| Campo | Rótulo | Tipo | Obrigatório | Observação |
|---|---|---|---|---|
releaseProtheus | Release do Protheus (informativo) | texto | não | Apenas para registro de interesse — a configuração é recusada enquanto o conector não existir. |
Step by step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose TOTVS Protheus in the catalog.
- Fill the form fields (see the table above).
- 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.
- Use Salvar conexão. Saving does NOT start any ingestion run.
- 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 executing anything. Then, Ativar agenda and Executar agora are separate actions.
In the current state (Roadmap), steps 4–5 are rejected by the product.
Example — connection test#
Example configuration (all values are fictitious; secrets appear masked):
# Exemplo sintético (valores fictícios — não são credenciais reais)
releaseProtheus = <releaseProtheus>Expected result#
The product rejects the configuration with a clear message that the connector is on the Roadmap.
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: ~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 scoping: 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 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: every error/log goes through secrets redaction (raw, URL-encoded and in JSON).
- Production does not fake: 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 necessary 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 permissions granted.
- 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 mentioning 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 issues before scheduling.
- Follow runs in the observability by connector (error rate, p50/p95, freshness).
- A schema change at the source is signaled by schema drift (new column = info; removed column/type change = 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 review: 2026-10-04. Ficha generated automatically from the product's connector catalog.