Conceitos e Glossário

Entendendo as principais entidades do OlaClick Hub.

Como funciona

┌────────────┐         ┌──────────────┐         ┌─────────────┐
│  Connector │──has──►  │  Connection  │◄──has──  │   Company   │
│  (seu app) │         │  (o vínculo) │         │ (restaurante)│
└────────────┘         └──────────────┘         └─────────────┘

Um Connector cria uma Connection com uma Company para acessar seus dados via a API.

Entidades

Connector

Um Connector é uma aplicação ou plataforma externa que se integra com a OlaClick. Ele representa seu sistema como um todo.

• Possui um único conjunto de credenciais OAuth (client_id + client_secret)
• Pode se conectar a múltiplas Companies
• Gerencia suas conexões por meio de scopes no nível do connector

Exemplos: um sistema de PDV, um agregador de entregas, uma plataforma de analytics.

Company

Uma Company é um restaurante ou negócio de alimentação registrado na OlaClick. As Companies têm seus próprios pedidos, menu, clientes e configurações.

• Identificada por um company_id (UUID)
• Pode estar conectada a múltiplos Connectors
• O proprietário da empresa aprova ou gerencia as conexões a partir do painel OlaClick

Connection

Uma Connection é o vínculo entre um Connector e uma Company. Ela determina quais dados o Connector pode acessar para aquela Company específica.

• Possui um status que controla o acesso
• Criada quando uma empresa instala/conecta sua aplicação
• Vinculada a um único par (Connector, Company)

Status de Connection

Status	Descrição	Acesso à API
pending	Conexão criada, aguardando aprovação do connector	Não
active	Conexão aprovada e operacional	Sim
rejected	O connector rejeitou a conexão	Não
revoked	A empresa ou o sistema revogou o acesso	Não

Transições de status

pending → active     (o connector aprova)
pending → rejected   (o connector rejeita)
active  → revoked    (a empresa ou o sistema revoga)

Glossário

Termo	Definição
Connector	Sua aplicação registrada no OlaClick Hub
Company	Um restaurante/negócio na OlaClick (identificado por company_id)
Connection	O vínculo entre um Connector e uma Company
Connector Token	Token OAuth sem contexto de empresa — para gerenciar suas próprias conexões
Company Token	Token OAuth com company_id — para acessar os dados de uma empresa específica
Scope	Permissão concedida a um token (ex.: orders:read, conections:write)
client_id	Identificador público do seu cliente OAuth
client_secret	Credencial secreta para autenticar seu cliente OAuth
application_id	UUID interno que identifica sua aplicação connector

Resumo de relacionamentos

Relacionamento	Cardinalidade
Connector → Connections	Um para muitos
Company → Connections	Um para muitos
Connector → Companies (via Connections)	Muitos para muitos