Skip to main content

Partner Integration: Functional Workflow Guide

Introduction​

The yuu standardized integration specification initiative defines a common, standardized way for partners, channels, and internal banners to connect with the yuu ecosystem.

In terms of benefits to banner & partners with the standardized approach, this aims to enhance and achieve:

  1. Faster onboarding and time-to-market
    • Reusable patterns and clear guidelines reduce discovery and development time within each banner and partners, rollout and release can go live more quickly.
  2. Consistent and secure SSO experience
    • A unified SSO flow and security model simplifies compliance, reduces security risks, and delivers a consistent login experience for end users.
  3. Predictable, well-designed APIs
    • Standardized API contracts, error handling, and payload structures make integrations easier to build, test, and troubleshoot.
  4. Easier long-term evolution
    • Versioning, backward compatibility guidelines, and common change-management practices make it simpler to adopt new capabilities without breaking existing integrations.
  5. Scalability across markets and channels
    • Once a pattern is proven, it can be reused across multiple banners and sub-brands, markets, and channels with minimal additional effort.
  6. Fewer defects & Better observability and support
    • Established patterns and reference implementations reduce integration variability, leading to more stable solutions and fewer production issues.
    • Shared monitoring, logging, and incident-handling standards help detect issues earlier and resolve them faster, with clearer ownership and SLAs.

Online vs Offline yuu Account Authentication​

Please refer to the following journey descriptions for online and offline authentication details.

(A) Online Authentication

(B) Offline Authentication

Points Earn Only vs Burn Points for Rewards​

Please refer to the following sections for journey descriptions for Points Earn / Burn points for Rewards:

(A) Points Earn Only

(B) Burn Points for Rewards

Overview — Partner System Integration​

Figure 1 — Partner Systems Integration Architecture

The diagram illustrates the integration architecture between a partner's systems and the yuu Loyalty Platform, organized into several main components and integration flows:

Key Systems & Components​

  • Partner's Core System: Maintains Store Master and Item Master data, sent to the yuu Loyalty Platform via SFTP.
  • Partner's Voucher System: Sends Issued Vouchers to the yuu Loyalty Platform via SFTP.
  • yuu Data Lake: Ingests sales data, store/item master files (via SFTP) and receives yuu Sync Files (Voucher Issued, Points, and Rewards History) from the Loyalty Platform.
  • SFTP: Batch file transfer channel for sales data, master files, vouchers, and daily point records.
  • API Layer: Exposes real-time endpoints for authentication, membership, transactions, and rewards; connected to the yuu Loyalty Platform via Loyalty APIs (POS).
  • yuu Loyalty Platform: Core platform that processes loyalty transactions, issues rewards, and syncs data back to the yuu Data Lake.

Integration Flows​

  • Batch (SFTP): Sales data flows from SFTP to the Data Lake. Store Master and Item Master are sent from the Partner's Core System to the yuu Loyalty Platform via SFTP.
  • Batch (SFTP): Issued Vouchers are pushed from the Partner's Voucher System to the yuu Loyalty Platform; Daily Point Files (Base & Bonus) are also sent via SFTP.
  • Platform → Data Lake: yuu Sync Files (Voucher Issued, Points, and Rewards History) flow back from the Loyalty Platform to the Data Lake.
  • Platform → Partner: Issued Rewards are returned to the partner from the yuu Loyalty Platform.
  • Visual key: Blue arrows = real-time flows · Green arrows = batch/file-based flows.

API & SDK Integration​

  • API Endpoints & SSO: yuu Account Authentication, Membership, Transaction (Earn), Rewards (Burn) — consumed by Partner POS / e-commerce.
  • SDK Methods: yuu SDK Login & Registration, yuu SDK QR Code Page, Display & Burn Redeemed Rewards.
  • Loyalty APIs (POS): Connect the API Layer to the yuu Loyalty Platform for real-time transaction processing.

Base URL for accessing yuu API​

Please use the following URL as the base for all Partner POS API endpoints.

SIT/UAT:

https://www.dairyfarm-ipaas-df-nonprod.com/testhk/pos/loyalty/exp/v1/

PROD:

https://www.dairyfarm-ipaas-df.com/hk/pos/loyalty/exp/v1