BUILD WITH IMBOSS
Developer documentation.
Connect customer apps and store experiences with IMBOSS. Read the detailed API references and integration guides, or explore the same contracts interactively with Swagger UI.
Customer API →
Sign in customers, browse branches, manage profiles, show loyalty progress and access rewards and wallet passes.
/api/app/v1Uses X-App-Id and a customer bearer token after sign-in.
Staff API →
Sign in staff devices, look up customers, award points, manage purchases and redeem vouchers within authorized branches.
/api/staff/v1Uses a staff bearer token obtained with a personal username and password.
GET STARTED
Getting access
Documentation is public. API access depends on the business's enabled features and access grants. Contact the platform team for the intended environment, app ID and account setup, then follow the integration guide in the relevant reference.
Loyalty operations require Loyalty access. External POS integrations use a separate API key and access grant; the Staff contract describes the staff token API.
Examples use fictional data and credential placeholders. Keep tokens secure and use the agreed test environment before sending writes to production.
MACHINE-READABLE CONTRACTS
OpenAPI downloads
Import the OpenAPI 3.0 contracts into your API tooling to explore requests and responses.