Skip to main content

Concepts & Glossary

Understanding the key entities in OlaClick Hub.

How it works​

┌────────────┐         ┌──────────────┐         ┌─────────────┐
│ Connector │──has──► │ Connection │◄──has── │ Company │
│ (your app)│ │ (the link) │ │ (restaurant) │
└────────────┘ └──────────────┘ └─────────────┘

A Connector creates a Connection with a Company to access their data via the API.

Entities​

Connector​

A Connector is an external application or platform that integrates with OlaClick. It represents your system as a whole.

  • Has one set of OAuth credentials (client_id + client_secret)
  • Can connect to multiple Companies
  • Manages its connections via connector-level scopes

Examples: a POS system, a delivery aggregator, an analytics platform.

Company​

A Company is a restaurant or food business registered in OlaClick. Companies have their own orders, menu, clients, and settings.

  • Identified by a company_id (UUID)
  • Can be connected to multiple Connectors
  • The company owner approves or manages connections from the OlaClick panel

Connection​

A Connection is the link between a Connector and a Company. It determines what data the Connector can access for that specific Company.

  • Has a status that controls access
  • Created when a company installs/connects your application
  • Scoped to one (Connector, Company) pair

Connection Statuses​

StatusDescriptionAPI access
pendingConnection created, waiting for connector approvalNo
activeConnection approved and operationalYes
rejectedConnector declined the connectionNo
revokedCompany or system revoked accessNo

Status transitions​

pending → active     (connector approves)
pending → rejected (connector declines)
active → revoked (company or system revokes)

Glossary​

TermDefinition
ConnectorYour application registered in OlaClick Hub
CompanyA restaurant/business on OlaClick (identified by company_id)
ConnectionThe link between a Connector and a Company
Connector TokenOAuth token without company context — for managing your own connections
Company TokenOAuth token with company_id — for accessing a specific company's data
ScopePermission granted to a token (e.g. orders:read, conections:write)
client_idPublic identifier for your OAuth client
client_secretSecret credential for authenticating your OAuth client
application_idInternal UUID identifying your connector application

Relationship Summary​

RelationshipCardinality
Connector → ConnectionsOne to many
Company → ConnectionsOne to many
Connector → Companies (via Connections)Many to many