Pular para o conteúdo principal

Connector Onboarding

Register as a connector and start receiving events from OlaClick companies.

How it works​

1. Register as a connector​

Contact the OlaClick integrations team with the following information:

Required information​

FieldDescription
Provider nameDisplay name in the marketplace (e.g. "Nubefact")
Country of operationCountries where the integration will operate
Contact emailEmail for technical communication
WhatsApp numberPhone number for direct support
Logo URLURL to your connector's logo image
App descriptionBrief description of what your integration does
App categoryFiscal notes, logistics, CRM, marketplace, POS, etc.
KYC detailsOptional — iframe URL or redirect URL for document validation
Estimated development timelineWhen you expect to be ready for homologation

Webhook events to subscribe​

Select which events your connector needs to receive.

→ See Available Events for the full list with descriptions.

Public API scopes needed​

Select the scopes your connector requires.

→ See Scopes for the full list with descriptions.

Once approved, your connector is listed in the OlaClick Marketplace for the countries you selected.

2. Receive binding events​

When a company activates your connector from the OlaClick Marketplace:

  1. OlaClick creates a connection between the company and your connector with status pending
  2. OlaClick creates a webhook configuration for that company pointing to your webhook URL
  3. OlaClick sends a CONNECTION_CREATED event to your webhook

The event's data field contains:

FieldDescription
merchant_idThe company identifier — store it for authentication
webhook_urlYour registered webhook URL
subscribed_eventsEvent types the webhook is subscribed to

Respond with 200 OK to confirm receipt.

Event reference: CONNECTION_CREATED — full payload and schema.

perigo

Each connection is unique per company. Never mix data between companies.

3. Authenticate with the API​

Use the OAuth 2.0 client credentials flow to obtain access tokens. See Authentication for full details.

  • Connector Token (no company_id) — for managing connections (KYC status updates)
  • Company Token (with company_id) — for accessing company data (orders, invoices)

4. Complete homologation​

Before going to production, complete the homologation process for each module. Each module has an independent homologation.

Best Practices​

dica
  • Respond 200 immediately and process events in background — long response times trigger retries and repeated failures can suspend your webhook
  • Deduplicate by event_id — retries may deliver the same event more than once
  • Cache tokens using expires_in as TTL — on 401, invalidate and request a new one, retry once, then stop
  • Verify signatures on every delivery — see Signature Verification

Next steps​