Integration Types
Smarts supports two integration approaches. Choose the one that matches your system architecture.
ePOS Integration
The ePOS integration is for electronic cash registers (ECRs) that embed the Smarts ePOS browser-based GUI. Communication between the ECR and the Smarts platform uses the postMessage protocol — a cross-origin messaging standard for browser-embedded applications.
This integration type is suitable when:
- Your ECR embeds a browser component (e.g. Chromium Embedded Framework, WebView).
- You want the Smarts GUI to handle the customer-facing payment and coupon screens.
- You are integrating multiple Smarts modules (Gateway, Tender, Boost, Loyalty) through a single interface.
The ePOS path requires device authentication, understanding of the postMessage protocol, and Gateway integration as a prerequisite for Tender and Boost operations.
Partner API Integration
The Partner API integration provides REST endpoints for systems that do not use the Smarts ePOS GUI. Payment and coupon operations are performed via standard HTTPS requests with JSON payloads.
This integration type is suitable when:
- You operate self-checkout kiosks, vending machines, or other headless devices.
- You control the full customer journey and user interface.
- You prefer a REST API over browser-based postMessage flows.
- You are integrating a single module (e.g. Tender only or Boost only) without the full ePOS stack.
The Partner API path requires partner credentials (clientId, clientSecret, X-Partner-Id) and uses JWT-based authentication.
Comparison
| ePOS Integration | Partner API Integration | |
|---|---|---|
| Protocol | postMessage (browser) | REST / HTTPS |
| GUI | Smarts ePOS GUI embedded in ECR | Partner provides their own UI |
| Authentication | Device access token | JWT Bearer token |
| Modules available | Gateway, Tender, Boost, Loyalty | Tender, Boost |
| Typical use case | Traditional POS with embedded browser | Self-checkout kiosks, headless devices |
| Prerequisites | Device auth, postMessage setup, Gateway | Partner credentials, base URL |
Next Steps
- ePOS Integration — start with the Getting Started guide to set up device authentication and the postMessage protocol.
- Partner API — Tender — see the Tender Partner API for gift card and prepaid card payments.
- Partner API — Boost — see the Boost Partner API for coupon redemption and management.