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
| Status | Description | API access |
|---|---|---|
pending | Connection created, waiting for connector approval | No |
active | Connection approved and operational | Yes |
rejected | Connector declined the connection | No |
revoked | Company or system revoked access | No |
Status transitions
pending → active (connector approves)
pending → rejected (connector declines)
active → revoked (company or system revokes)
Glossary
| Term | Definition |
|---|---|
| Connector | Your application registered in OlaClick Hub |
| Company | A restaurant/business on OlaClick (identified by company_id) |
| Connection | The link between a Connector and a Company |
| Connector Token | OAuth token without company context — for managing your own connections |
| Company Token | OAuth token with company_id — for accessing a specific company's data |
| Scope | Permission granted to a token (e.g. orders:read, conections:write) |
| client_id | Public identifier for your OAuth client |
| client_secret | Secret credential for authenticating your OAuth client |
| application_id | Internal UUID identifying your connector application |
Relationship Summary
| Relationship | Cardinality |
|---|---|
| Connector → Connections | One to many |
| Company → Connections | One to many |
| Connector → Companies (via Connections) | Many to many |