The Spaaza Feature API
Spaaza's Feature API allows developers to create their own applications on top of the Spaaza platform using feature-specific endpoints. All Spaaza's in-house apps and other services make use of the API endpoints described in this documentation.
Spaaza also has a newer, RESTful Resources API which supports a growing set of use cases.
API Environments
Spaaza provides separate environments for testing and production use. Each environment has its own set of hostnames for the various Spaaza services:
- API: The core Spaaza API, used for user management, baskets, campaigns, vouchers, and other platform operations.
- Services API: The Spaaza Services API, used for user search, segment exports, receipts, and analytics queries.
- Embed Elements: The Spaaza Embed Elements CDN, used for loading the Spaaza UI components into your web pages.
Spaaza will provide you with the appropriate hostnames for each environment as part of your onboarding. Throughout this documentation, the following placeholders are used to represent environment-specific hostnames:
| Placeholder | Description |
|---|---|
{API hostname} | The hostname for the core Spaaza API |
{Services API hostname} | The hostname for the Spaaza Services API |
{Embed Elements hostname} | The hostname for the Spaaza Embed Elements CDN |
{Embed hostname} | The hostname for a Spaaza Embed (iFrame) application |
{MyPrice App hostname} | The hostname for your brand's MyPrice app |
{Spaaza Store hostname} | The hostname for the Spaaza Store web application |
For example, an API call to the add-basket endpoint would be made to:
https://{API hostname}/auth/add-basket
If you do not yet have your environment hostnames, please contact Spaaza support.
Useful API resources
Developer tools
Spaaza also provides developer tooling to help you explore, test, and work with the API more efficiently.
YouTube channel
There are some videos on the Spaaza YouTube channel including the following:
Getting started with the Spaaza API
More of these are coming soon - we add guides and videos frequently.