Integration model

This page covers the basic business scenarios linked to specific SkyJoy services that your customers experience when integrating with SkyJoy.

For details about using API, see API Reference.

Term and Definition

To begin, take a look at the table to understand objects:

Criteria	Description
SkyJoy ID	The SkyJoy member unique identifier generated from SkyJoy Server with format SJxxxxxxxxxx (10 digits)
SkyID	The customer identity storage and management system, providing authentication services for SkyJoy platforms
Customer ID	The customer unique identifier code generated from SkyJoy's Partner Server
SkyPoint	A virtual currency referred as points used within the SkyJoy platform

Membership (Offline Model)

This section describes the Main Scenario that must be linked with the SkyJoy System in the process of membership registration and use without partner apps.

For users who visit offline stores and register SkyJoy accounts for point utilization, follow five steps:

• Step 0: New customers download and register on the SkyJoy App.
• Step 1: Customers show their SkyJoy QR code while purchasing items at your store. The code is received through POS.
• Step 2: Your system gets the purchase details including the customer's SkyJoy ID from the SkyJoy QR Code. The code is also added to the bills.
• Step 3: Your system handles the payment internally and then transfers transaction details, including SkyJoy ID, to SkyJoy System through Point API or Batch transaction method.
• Step 4: SkyJoy System processes the transactions, and delivers the results to your system in real-time.
• Step 5: SkyJoy System sends a push notification to the SkyJoy App.

WARNING

SkyJoy only pushes notifications if only transactions are successful.

Membership (Online Model)

This section outlines the Main Scenario during the membership registration process and interaction with the SkyJoy application.

Below is the complete process divided into two parts: SkyJoy App Connection and Online Transaction, consisting of 7 steps.

SkyJoy App connection

from step 1 to step 3

• Step 1: When a customer selects SkyJoy touchpoint on your app, your app checks whether this customer is a SkyJoy customer. Below are the general steps for users to sign-in/ sign-up on your site. SkyID supports some methods for authentication that can be optionally chosen for your demand:
  • iFrame: SkyJoy iFrame is an embedded web element within Partner websites or apps, allowing users to sign-in/ sign-up directly on Partner platforms without navigating away from the Partner's interface. Learn more at iFrame.
  • Regular Web App: This method enables users logging into Partner websites or apps are redirected to SkyJoy's authentication page, where they can sign in or sign up using their SkyJoy credentials. Once authenticated, users are redirected back to the Partner platform. Learn more at Regular Web App.
  • Single Page App: By using a "Sign in with SkyJoy" button on your app, your users are prompted to create an account with a dialog that's inline with your app's content, so they're never taken out of context by directing to SkyJoy app. Learn more at Single Page App.
  • Backend API: Separate integration method that applies for the strategic partners. This method allows users login in and interact with SkyJoy functions directly in the Partner platform. Contact SkyJoy team for the proposal.
• Step 2: Your system transmits customer information, including Customer ID, phone number, full name, and date of birth, to SkyJoy System for validation.
• Step 3: SkyJoy System responds with the following results:
  • If the user profile does not exist, the system creates a new account and returns the member profile.
  • If the profile already exists, the system returns the registered member profile.
  • If the profile exists and is linked to another Customer ID, the system returns the error message "This account is already linked in the system."

Online transaction

from step 4 to step 7

• Step 4: When a purchase is made on your app, purchase detail is transmitted to your system.
• Step 5: Your system processes purchase details and interacts with SkyJoy System in specific cases below:
  • For point accrual/ earning: Your system forwards transaction details to SkyJoy System. This can be executed through the Point API or as a Batch transaction method.
  • For point redemption: Your system calls API to check whether the customer is a SkyJoy user and verifies if their SkyPoint balance is sufficient. If confirmed, continue to call Redemption API to handle the transaction.
• Step 6: SkyJoy System processes points earning or redemption and responds with the results to your system; see transaction API.
• Step 7: SkyJoy System sends a push notification to SkyJoy App in the event of successful transactions.

INFO

During redemption events, users may encounter restrictions in using SkyPoints because some points could be temporarily locked due to ongoing activities in the SkyJoy System.