Appearance
Application Anatomy
An application in POS Hub is a software entity created by a registered user, known as the application owner, to extend and integrate additional functionalities into the POS Hub ecosystem. These applications are built using OAuth2 based authentication and are available on the marketplace, making them installable across multiple stores / locations.
Application Ownership
The registered user who creates and manages the application. This owner is responsible for:
- Configuring and updating application settings.
- Managing access control and credentials.
- Overseeing audits and analytics to monitor application performance and security.
- Ensuring compliance with platform standards and best practices.
Application Capabilities
Every application in POS Hub comes with a set of capabilities that enable seamless integration and secure communication with the platform:
Client ID / Secret
Applications are assigned a randomly generated client ID and secret, these credentials can be thought of as a username and password for the application, and are used to authenticate the application with POS Hub when making API requests.
WARNING
The Client ID is a public identifier for the application, while the Client Secret is a private key that should be kept secure and not shared with anyone.
Reference: Client ID / Secret
Redirect URLs
Each application is required to configure a redirect url, this url will be used to redirect the user to back to your application after the user has installed the application.
INFO
By default, if the user installs your application from POS Hub directly, the user will be redirected to the first redirect url you have configured.
Webhook Endpoints
Applications that wish to receive events from POS Hub must configure a webhook endpoint, this endpoint will be used by POS Hub to send events to your application in real time.
See: Webhooks from the API Guides section.
Types of Applications
Applications in POS Hub are classified into categories, the category determines where the application appears within the marketplace, what configuration options are required, and what data the application can access.
The main types of applications are:
- Marketplace: Responsible for receiving a menu from POS Hub, publishing it to the marketplace, and managing the menu lifecycle. These applications also sync orders placed through the marketplace back to POS Hub.
- POS: Responsible for synchronizing the catalog (products, modifiers, categories) from the external POS system to POS Hub. Also convert order events from POS Hub into the external POS system and sending order updates back to POS Hub.
- Delivery: Responsible for providing quotes for specific jobs, and dispatching quotes if the quote was accepted. These applications also provide real time delivery and driver tracking updates back to POS Hub.
- Other: Applications that do not fit into the above categories and have custom functionality, such as printers, stock management, or other integrations.
Below is a responsibility matrix table that outlines the key responsibilities of each application type, the header rows contain the application types, and the first column contains the responsibilities.
| Responsibility | Marketplace | POS Application | Delivery Application |
|---|---|---|---|
| Receive Menu | Yes | No | No |
| Sync Catalog | No | Yes | No |
| Create Order | Yes | Yes | No |
| Update Order Statuses | No | Yes | No |
| Update Order Driver Status | Yes | No | No |
| Send Order Updates to POS Hub | No | Yes | No |
| Produce Quote | No | No | Yes |
| Refresh Quote | No | No | Yes |
| Dispatch Quote | No | No | Yes |
| Cancel Dispatched Job | No | No | Yes |
| Update Dispatched Job Status | No | No | Yes |