Skip to content

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

Updated on 2026-10-04

iFood — connector

Reads the sales report (Financial API) and the store reviews from iFood's Merchant API and loads them into the Bronze layer.

On this page (15)

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


What it is#

Reads the sales report (Financial API) and the store reviews from iFood's Merchant 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 iFood 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 included in all plans; the limit is the number of sources allowed by the plan).
  • Access: requires an active workspace — if the subscription is overdue, suspended or canceled, the execution is blocked.
  • Shutdown: ingestion runs can be temporarily disabled (maintenance or incident). When that happens, the UI shows the resource is currently unavailable.

Prerequisites#

  • An iFood account with access to the data you want to ingest.
  • In the iFood Developer Portal, create a centralized application with the Financial and Reviews modules, link the store (merchant) and copy the Client ID and Client Secret. Also paste the store ID here (merchantId, a UUID). The secret is encrypted (AES-256-GCM) and never shown again; the access token is auto-renewed.

Credentials#

Authentication method: Application credentials (client id/secret) exchanged for an access token.

Sensitive fields. They are encrypted (AES-256-GCM) and are never stored in the config of the connection, in the pipeline definition, in exports or in the DAG. By default the encrypted value is kept 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.

  • Client Secret (clientSecret)

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

Form fields#

FieldLabelTypeRequiredNote
merchantIdStore ID (merchantId)textyesStore UUID in iFood (Portal do Parceiro → Dados da loja).
clientIdClient IDtextyesApplication credential generated in the iFood portal.
clientSecret 🔒Client Secretpassword/secretyessecret (encrypted; external vault optional)

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose iFood in the catalog.
  3. Fill the form fields (see the table above).
  4. Use Testar conexão. The result is shown separately for Network (server reach), Authentication (user and password) and Read (list tables) — each with OK, Failed, Not applicable or Not tested.
  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. Afterwards, 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)
merchantId = <merchantId>
clientId = exemplo-client-id-ficticio
clientSecret = •••••• (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 per workspace: 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 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 source.
  • Redaction: every error/log is passed 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 required permission. Reconnect the source (the source and history are preserved; do not recreate the source).
  • Rate limit (429) — the provider asked to wait. 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 — extraction stops when the API cursor does not advance (anti-loop guard). If it happens in consecutive runs, open a support ticket specifying the connector and the resource.
  • Empty record path — the response arrived without records where expected. 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.
  • Follow 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. Card automatically generated from the product connectors catalog.

Related links