Public API

How to get the API key

To start using Public API, you’ll first need to retrieve your unique API key. Follow these steps:

1. From the Navigation Tab, click on Settings.

2. Scroll down to the Public API section.

3. Locate your API key and click Copy to save it to your clipboard.

⚠️ Note: Keep your API key secure. Do not share it publicly or expose it in client-side code.

Rule endpoints

There are fields of rule, you need to understand:

1. Customers

Field	Type	Description
id		Unique identifier for the customer in your system
birthday		Customer's date of birth
shopifyCustomerId		The corresponding customer ID from your Shopify store.
email	string	Customer's email address
points		Total loyalty points the customer has accumulated
status	boolean	Indicates the current status of the customer account
createdAt		Timestamp of when the customer record was created
updatedAt		Timestamp of the last update to the customer record

1. Rewards

Field	Type	Description
id		Unique identifier for the reward record
type		The category of the reward event
settingType
description
oldPoints
newPoints
createdAt
updatedAt

1. Activities

Field	Type	Description
id
shopifyDiscountId
discountCode
description
status
createdAt
updatedAt

List all customers

GET /rest-api/v1/customers

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

Tab 1

// Some code

Return a single customer

GET /rest-api/v1/customers/{id}

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

{
  "error": "Invalid request"
}

Update birthday

POST /rest-api/v1/customers/updateBirthday

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

{
  "error": "Invalid request"
}

List all rewards

GET /rest-api/v1/rewards

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

{
  "error": "Invalid request"
}

List all activities

GET /rest-api/v1/activities

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

{
  "error": "Invalid request"
}

Update points

POST /rest-api/v1/points/add

POST /rest-api/v1/points/substract

POST /rest-api/v1/points/update

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

{
  "error": "Invalid request"
}