API If Loyalty Program 1.4.2

Loyalty Program interface Documentation
Release 1.4
May, 3 2018
Page 1 of 23
HEADQUARTER: Jl. Bukit Gading Raya BRANCH OFFICE: Jl. Pengiyasan Raya No.2B
Perkantoran Gading Bukit Indah Blok O No. 3-5 Sanur, South Denpasar
Jakarta 14240 - Indonesia Bali 80227- Indonesia
Phone : +62 21 4513678 (Hunting) Phone : +62 361 849 7960 (Hunting)
Fax : +62 21 4513845 Fax : +62 361 8234 335
E-mail : info@sindata.net E-mail : vhpbali@sindata.net
Website : www.sindata.net Wesite : www.sindata.net
Content
Transaction API .................................................................................................................................... 3
1. Adding Outlet’s Transaction ..................................................................................................... 3
1.1 Request .............................................................................................................................. 3
1.2 Responses ....................................................................................................................... 10
2. Adding FO’s Transaction ........................................................................................................ 12
2.1 Request ............................................................................................................................ 12
2.2 Response ......................................................................................................................... 17
Membership API ................................................................................................................................. 19
1. Getting Membership Data....................................................................................................... 19
1.1 Request ............................................................................................................................ 19
1.2 Response Data ................................................................................................................ 19
1.3 Response Headers.......................................................................................................... 19
1.4 Examples.......................................................................................................................... 20
2. Register Membership.............................................................................................................. 22
2.1 Request ............................................................................................................................ 22
2.2 Response Data ................................................................................................................ 22
2.3 Response Headers.......................................................................................................... 23
2.4 Examples.......................................................................................................................... 23
Page 2 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
Transaction API
1. Adding Outlet’s Transaction

Method : POST
1.1 Request
Parameter Required Description
token Yes Authentication String
Email Address / Member ID Indicating
user Yes Customer. Leaving this empty creates an
open transaction.
A number (id) indicating store where
store Yes
transaction is created
POS Transaction number (must be unique
invoice_number Yes
daily)
A number indicating transaction's grand
total_value Yes
total
An integer indicating the number of people
number_of_people Yes
involved in transaction
ISO 8601 date time format to indicate
created Yes transaction's created date (e.g 2013-02-
15T13:01:01+07)
subtotal No A number indicating transaction's subtotal
A number indicating transaction's discount
discount No
(in Rp)
service_charge No A number indicating service charge (in Rp)
tax No A number indicating transaction tax (in Rp)
List of items containing product name or
items Yes category name, quantity & price. Price is the
combined price of product (qty * unit_price)
Page 3 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
Request by item detail:
"total_transaction": 3,
"transaction": [{
"token": "87d4ae35c99104c81a539933c5ae1624cbdb3806",
"user": "458347",
"store": 801,
"invoice_number": "22901-15-03",
"total_value": 54450,
"number_of_people": 2,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T09:30:01",
"items": [{
"product_name": "Assorted Siomay",
"quantity": 1,
"price": 54450
}]
},
"user": "455076",
"store": 801,
Page 4 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
"tax": 0,
"discount": 0,
"created": "2017-11-20-T09:30:01",
"items": [{
"product_name": "Beef Balck Paper Sandwitch",
"quantity": 1,
"price": 82280
}]
},
"user": "279117",
"store": 801,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T09:30:01",
Page 5 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
"items": [{
"product_name": "Beef Katsu Curry",
"quantity": 1,
"price": 90750
}]
Page 6 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
Request by item category:
"Transaction": [{
"user": "458347",
"store": 801,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T09:30:01",
"items": [{
"product_name": "Food",
"quantity": 1,
"price": 54450
}]
},
"user": "455076",
"store": 801,
Page 7 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
"tax": 0,
"discount": 0,
"created": "2017-11-20-T09:30:01",
"items": [{
"quantity": 1,
"price": 82280
}]
},
"user": "279117",
"store": 801,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T09:30:01",
"items": [{
"quantity": 1,
"price": 90750
},
Page 8 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
{
"product_name": "Beverage",
"quantity": 1,
"price": 89540
},
"product_name": "Other",
"quantity": 1,
"price": 25320
Page 9 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
1.2 Responses
Depending on the request, responses may return these status codes:
Code Description
200 Everything worked as expected
400 Bad Request, usually missing a required parameter
401 Unauthorized, usually missing or wrong authentication token
403 Forbidden - You don't have permission for this request
HTTP Method not allowed - The requested resources cannot be called

405
with the specified HTTP Method
500,
502,
Server Errors - Something is wrong on Loyalty Program's end
503,
504
Below are a few examples responses on successful API Calls:
If transaction is successful (JSON):
HTTP/1.1 200 OK
Date: Wed, 21 Feb 2018 07:20:43 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept-Encoding
Allow: POST, OPTIONS
Success
When some fields don’t validate (JSON):
HTTP/1.1 400 BAD REQUEST

Date: Wed, 21 Feb 2018 07:20:43 GMT
Failed
Page 10 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
If HTTP is used instead of HTTPS

Date: Wed, 21 Feb 2018 07:20:43 GMT
{“detail”: “Please use https instead of http”}
If missing or wrong authentication token:

Date: Wed, 21 Feb 2018 07:20:43 GMT
{“detail”: “Authentication credentials were not provided”}
Page 11 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
2. Adding FO’s Transaction
Method: POST
2.1 Request
Email Address / Member ID Indicating
user Yes Customer. Leaving this empty creates an
open transaction.
A number (id) indicating store where
store Yes
transaction is created
POS Transaction number (must be unique
invoice_number Yes
daily)
A number indicating transaction's grand
total_value Yes
total
An integer indicating the number of people
number_of_people Yes
involved in transaction
ISO 8601 date time format to indicate
created Yes transaction's created date (e.g 2013-02-
15T13:01:01+07)
subtotal No A number indicating transaction's subtotal
A number indicating transaction's discount
discount No
(in Rp)
service_charge No A number indicating service charge (in Rp)
tax No A number indicating transaction tax (in Rp)
List of items containing product name or
items Yes category name, quantity & price. Price is the
combined price of product (qty * unit_price)
Page 12 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
Request by Item Category:
{
"transaction": [{
"token": "d93c621909aae27ac8b51b9e2a5fb4c15c5e1f68",
"user": "458347",
"store": 800,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T10:00:59",
"items": [{
"product_name": "Room",
"quantity": 1,
"price": 997500
}]
},
{
"user": "279117",
"store": 800,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T10:00:59",
"items": [{
"quantity": 1,
"price": 1179000
},
{
"product_name": "Halfday Meeting Package
Promo",
"quantity": 1,
"price": 250000
},
{
"product_name": "Fullday Meeting Package Promo",
"quantity": 1,
"price": 300000
},
Page 13 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
{
"quantity": 1,
"price": 50000
},
{
"quantity": 1,
"price": 125000
}
]
},
{
"user": "455076",
"store": 800,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T10:00:59",
"items": [{
"quantity": 1,
"price": 1058000
},
{
"quantity": 1,
"price": 25000
},
{
"quantity": 1,
"price": 15000
}
]
}
]
}
Page 14 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
Request by Item Category with Room Type
{
"transaction": [{
"user": "458347",
"store": 800,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T10:00:59",
"items": [{
"product_name": "Room - Twin",
"quantity": 1,
"price": 997500
}]
},
{
"user": "279117",
"store": 800,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T10:00:59",
"items": [{
"product_name": "Room - Deluxe",
"quantity": 1,
"price": 1179000
},
{
"product_name": "Halfday Meeting Package Promo",
"quantity": 1,
"price": 250000
},
{
"product_name": "Fullday Meeting Package Promo",
"quantity": 1,
"price": 300000
},
Page 15 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
{
"quantity": 1,
"price": 50000
},
{
"quantity": 1,
"price": 125000
}
]
},
{
"user": "455076",
"store": 800,
"tax": 0,
"discount": 0,
"created": "2017-11-20-T10:00:59",
"items": [{
"product_name": "Room - Superior",
"quantity": 1,
"price": 1058000
},
{
"quantity": 1,
"price": 25000
},
{
"quantity": 1,
"price": 15000
}
]
}
]
}
Page 16 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
2.2 Response
Depending on the request, response may return these status code:
Code Description
HTTP Method not allowed - The requested resources cannot be

405
called with the specified HTTP Method
500,
502,
503,
504
Below are a few examples responses on successful API Calls.
If transaction is successful (JSON)
HTTP/1.1 200 OK
Date: Wed, 21 Feb 2018 07:20:43 GMT
Vary: Accept-Encoding
Success
When some fields don’t validate (JSON)

Date: Wed, 21 Feb 2018 07:20:43 GMT
Failed
Page 17 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
If HTTP is used instead of HTTPS

Date: Wed, 21 Feb 2018 07:20:43 GMT
{“detail”: “Please use https instead of http”}
If missing or wrong authentication token

Date: Wed, 21 Feb 2018 07:20:43 GMT
Page 18 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
Membership API
1. Getting Membership Data

Method: GET
1.1 Request
You can query for a guest’s data on Loyalty Program Side

A string indicating customer's email,
user Yes member ID, mobile number or primary key
ID
Example of API call request using cURL:
#Please note that for cURL command you need to escape special character $
cURL:
‘https://loyaltyprogram.com/token=abc&user=customer@sindata.net&merchant=14’
1.2 Response Data

Variable Description
membership Membership related information
users User related information
1.3 Response Headers

Code Description

405
500,
502,
503,
504
Page 19 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
1.4 Examples
On a successful API Call:
HTTP/1.1 200 OK
Date: Wed, 21 Feb 2018 07:20:43 GMT
Vari: Accept-Encoding
{
"membership": {
"status": 100,
"points": 401,
"balance": 150000,
"start_date": "2018-02-21",
"created": "2018-02-21"
},
"guest": {
"membership_id": 12345,
"last_name": "Sindata",
"first_name": "Customer",
"email": "customer@sindata.net",
"sex": "M",
"birthdate": "1990-11-26",
"country_code": "+62",
"mobile_number": "123456789",
"address": "Jl. abc",
"is_active": true
}
}
Page 20 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
API Call with missing parameters:

Date: Wed, 21 Feb 2018 07:20:43 GMT
{
"errors": {
"__all__": "User Not Found",
"error_message": "User Not Found",
"error_code": "invalid_data",
"detail": "__all__: User Not Found"
}
}
If missing or wrong authentication token:

Date: Wed, 21 Feb 2018 07:20:43 GMT
Page 21 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
2. Register Membership
2.1 Request
You can request for register a guest on Loyalty Program Side.

String Indicating
Token Yes
Authentication String
Sring Indicating Last Name
Last Name Yes
of Guest
String Indicating First
First Name No
Name of Guest
String Indicating Email of
Email Yes
Guest
String Indicating Sex of
Sex No
Guest (M/F)
Date Indicating Birth Date
Birth Date Yes
of Guest
String Indicating
Country
Yes International Telephone
Code
Code
Mobile String Indicating Mobile
Yes
Number Number of Guest
String Indicating Address
Address No
of Guest
2.2 Response Data

Variable Description
membership Membership related information
users User related information
Page 22 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335
2.3 Response Headers
Code Description

405
500,
502,
503,
504
2.4 Examples
Authorization: Bearer {token-bearer}
{
"token": "92e59049c064823d189c18fc34a2461f97704f3b",
"last_name": "Customer",
"first_name": "Sindata",
"email": "customer@sindata.net",
"sex": "M",
"birth_date": "1990-11-26",
"country_code": "+62",
"mobile_number": "123456789",
"address": "Jl. ABC"
}
Page 23 of 23
Fax : +62 21 4513845 Fax : +62 361 8234 335

API If Loyalty Program 1.4.2

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

API If Loyalty Program 1.4.2

Загружено:

Авторское право:

Доступные форматы

Loyalty Program interface Documentation

Transaction API .................................................................................................................................... 3

1. Adding Outlet’s Transaction ..................................................................................................... 3

1.1 Request .............................................................................................................................. 3

1.2 Responses ....................................................................................................................... 10

2. Adding FO’s Transaction ........................................................................................................ 12

2.1 Request ............................................................................................................................ 12

2.2 Response ......................................................................................................................... 17

Membership API ................................................................................................................................. 19

1. Getting Membership Data....................................................................................................... 19

1.1 Request ............................................................................................................................ 19

1.2 Response Data ................................................................................................................ 19

1.3 Response Headers.......................................................................................................... 19

2.1 Request ............................................................................................................................ 22

2.2 Response Data ................................................................................................................ 22

2.3 Response Headers.......................................................................................................... 23

1. Adding Outlet’s Transaction

"product_name": "Assorted Siomay",

"product_name": "Beef Balck Paper Sandwitch",

"product_name": "Beef Katsu Curry",

401 Unauthorized, usually missing or wrong authentication token

403 Forbidden - You don't have permission for this request

HTTP Method not allowed - The requested resources cannot be called

Below are a few examples responses on successful API Calls:

If transaction is successful (JSON):

When some fields don’t validate (JSON):

HTTP/1.1 400 BAD REQUEST

HTTP/1.1 403 BAD REQUEST

{“detail”: “Please use https instead of http”}

If missing or wrong authentication token:

HTTP/1.1 403 BAD REQUEST

{“detail”: “Authentication credentials were not provided”}

401 Unauthorized, usually missing or wrong authentication token

403 Forbidden - You don't have permission for this request

HTTP Method not allowed - The requested resources cannot be

Below are a few examples responses on successful API Calls.

If transaction is successful (JSON)

When some fields don’t validate (JSON)

HTTP/1.1 400 BAD REQUEST

HTTP/1.1 403 BAD REQUEST

{“detail”: “Please use https instead of http”}

If missing or wrong authentication token

HTTP/1.1 403 BAD REQUEST

{“detail”: “Authentication credentials were not provided”}

1. Getting Membership Data

Parameter Required Description

Example of API call request using cURL:

1.2 Response Data

1.3 Response Headers

401 Unauthorized, usually missing or wrong authentication token

403 Forbidden - You don't have permission for this request

HTTP Method not allowed - The requested resources cannot be

HTTP/1.1 400 BAD REQUEST

If missing or wrong authentication token:

HTTP/1.1 403 BAD REQUEST

{“detail”: “Authentication credentials were not provided”}

Parameter Required Description

2.2 Response Data

401 Unauthorized, usually missing or wrong authentication token

403 Forbidden - You don't have permission for this request

HTTP Method not allowed - The requested resources cannot be

Вам также может понравиться