DOCSEARCHbyAlgolia
Submit Docs

Spaaza Developer Documentation

website·Indexed 33 days ago

https://oribi-test01.spaaza.com

Technical documentation for the Spaaza platform, featuring the Feature API for managing users, vouchers, campaigns, and baskets. Includes guides on JWT access token authentication, webhook signatures, Embed Elements styling with CSS custom properties, and webshop integrations.

Tokens
354.4K
Snippets
944
Records
2.3K
Agent score
45%

What's inside Spaaza

  1. Overview of Spaaza AccessToken resource

    The AccessToken resource represents a bearer access token issued to a ServiceClient for privileged API authentication. It uses a UUID as a primary key. A critical security constraint is that the plaintext token_secret is returned only once during the creation response; subsequently, only a bcrypt hash is stored, making the secret impossible to retrieve again.

  2. Overview of customer data import methods in Spaaza

    Spaaza allows the creation of unified customer profiles by importing data from legacy loyalty programs, CRM databases, or webshop/identity management systems. Most import processes require professional services support from Spaaza’s Technical Support Team. Data can be imported in real-time during customer interaction or via bulk CSV uploads.

  3. Overview of Composable Campaign reward imports

    Composable Campaigns allow for multiple reward methods, each with its own values, delivery settings, redemption restrictions, and limits. The CSV importer is used to add several reward methods (e.g., for a scratch-card prize pool) as editable drafts. No data is permanently saved until the user clicks 'Create Campaign' or 'Save Changes' on the campaign form. For survey campaigns, this importer is used specifically for completion rewards.

  4. Overview of Shopify and Spaaza data synchronization

    Data synchronization between Shopify and Spaaza ensures that customer profiles, transactions, and loyalty rewards remain consistent across both platforms. The synchronization is automatic and requires no manual intervention once the Spaaza Shopify app is installed and configured.

    • Shopify to Spaaza: Handled via Shopify webhooks.
    • Spaaza to Shopify: Handled via the Shopify Admin API.

  5. Overview of Spaaza AI Agent Skills

    AI Agent Skills are reusable instruction files designed to help AI assistants interact with the Spaaza API safely and consistently. They enable natural language interactions for tasks such as retrieving campaigns, updating campaign titles, or investigating API request failures, effectively acting as a guided, text-based alternative to Spaaza Console workflows.

  6. Overview of Personal Pricing campaign types

    Personal Pricing campaigns are used for checkout discounts triggered by qualifying baskets, products, or customer conditions. These are created from the 'Personal Pricing Discounts' campaign family in the Spaaza Console. Common campaign types include:

    • Simple Basket Discount
    • Fixed Monetary Discount
    • Free Product Basket Discount
    • Multibuy Bundle Discount
    • Bundle Discount (fixed)
    • Bundle Discount
    • Per Unit Discount

  7. Overview of Spaaza Wallets

    Wallets in Spaaza are used to manage points and digital currencies for incentive programs. They can be populated via Spaaza campaigns or through the API. There is no limit to the number of active wallets, and they can be targeted to specific user groups (e.g., a monetary wallet exclusively for influencers or a stamp card for VIPs).

  8. Overview of Spaaza Core DOM Events

    Spaaza components communicate via DOM events that bubble up. These events are categorized into user interactions (content:*), data-loading lifecycles (data:refresh:*), and UI state changes (ui:*). All events include a root field (the emitting component) and a pageContext field (the top parent page or detail).
    EventWhenYour response
    content:selectUser clicks itemHandle navigation
    content:action:startAction beginsOptional: show loading
    content:action:successAction completedOptional: analytics
    content:action:errorAction failedShow error
    data:refresh:requestComponent requests dataFetch and respond
    data:refresh:doneData loaded successfullyHide loading
    data:refresh:errorData load failedShow error state
    ui:render:doneComponent finished post-mount async workOptional: hide loading indicator

  9. Overview of Spaaza white-label mobile app features

    Spaaza provides a white-label mobile app for Android and iOS. The app supports loyalty and engagement features including vouchers, points, levels, member pricing, stamp cards, gamification, digital membership cards, and transaction history. Core utility functions include a store finder, push notifications, phone number/account verification, and Apple/Google Wallet integration. Content within the app can be targeted to specific stores or customer groups for personalization.

  10. Introduction to the Spaaza Resources API

    The Spaaza Resources API is a RESTful API conforming to OpenAPI standards, designed to provide a consistent interface for managing Spaaza resources. Note that the API is currently in BETA; while fully functional, some aspects may change based on user feedback and evolving requirements.

  11. Overview of Spaaza webshop integration options

    Spaaza provides tools for incentive marketing, loyalty programs, and referral systems that integrate with webshop systems. Integration is primarily achieved via the Spaaza API, which is used by webshops, Point of Sale (POS) systems, and email marketing solutions.

    Spaaza officially maintains extensions for the following platforms:

    • Adobe Commerce Cloud / Magento 2
    • Shopify
    • Salesforce Commerce Cloud (via OCAPI integration)
    • Magento 1 (Note: not actively maintained)

  12. Overview of Spaaza POS Integration

    Spaaza is a cloud-based platform for managing dynamic and personalized loyalty and incentive programs (such as referral or employee programs). Point of Sale (POS) systems integrate with Spaaza via its Application Programming Interface (API) to facilitate voucher redemption and the transmission of completed orders to the Spaaza platform. This integration allows POS systems to provide personalized incentives to customers and streamlined workflows for store staff.