BaseBS CRM Integration -
Technical Document
 
 
 
 
 
 
 
 
 

Date: 12/14/2022
Exported by Tran Nguyen Nguyen Thanh
Technical Document – BaseBS CRM Integration -

Table of Contents
1 TỔNG QUAN TÀI LIỆU/ Document Review .............................................3
2 Bảng theo dõi thay đổi/ Document Track Changes ...............................4
3 MỤC LỤC/ Table of Content......................................................................5
4 I. GIỚI THIỆU/ INTRODUCTION ................................................................6
4.1 1. Đối tượng sử dụng/ Users: ...................................................................................6
4.2 2. Phạm vi áp dụng/ Scope:.......................................................................................6
4.3 3. Mục đích/ Purpose: ................................................................................................6
4.4 4. Giải thích từ ngữ và từ viết tắt/ Word definition and Abbreviation: ..................6
4.5 5. Tài liệu tham khảo/ References.............................................................................7
4.6 6. Cấu trúc tài liệu/ Document structure ..................................................................7
5 II. TIÊU CHUẨN TÍCH HỢP/ INTEGRATION STANDARDS......................8
5.1 1. Mô hình tích hợp/ Integration Model ....................................................................8
5.2 2. Tiêu chuẩn kết nối/ Connecting Standards .........................................................8
5.3 3. Hướng dẫn kết nối/ Connecting Instruction........................................................8
5.4 4. Hướng dẫn xác thực/ Authentication Instruction ...............................................8
5.5 5. Tiêu chuẩn bảo mật/ Security Standard...............................................................8
6 III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE ..................................9
6.1 1. Tên miền/ Host: ......................................................................................................9
6.2 2. API Get Token: ........................................................................................................9
6.3 3. API Renew Token: ................................................................................................10
6.4 4. API Get User Info: (GET Method) ........................................................................12
6.5 5. API Get User Info (POST Method) .......................................................................13
7 IV. NON-FUNCTIONAL REQUIREMENT .................................................16
8 VI. TIÊU CHUẨN CHẤT LƯỢNG/ QUALITY CONTROL STANDARDS .17

– 2
Technical Document – BaseBS CRM Integration -

1 TỔNG QUAN TÀI LIỆU/ Document Review
Tên dự án/ Project
SKYJOY
Name

Người soạn thảo/ 
Thân Trọng Minh (Minh Than)
Composer

Phiên bản/ Version 1.0

Ngày/ Date 14/12/2022

TỔNG QUAN TÀI LIỆU/ Document Review – 3
Technical Document – BaseBS CRM Integration -

2 Bảng theo dõi thay đổi/ Document Track Changes

Người soạn 
Mục đích/  Tóm tắt/  Phiên bản/ 
Ngày/ Date thảo/ 
Purpose Summary Version
Composer

Khởi tại tài liệu. 
Mô tả cách 
Mô tả chi tiết kết 
SkyJoy nhận 
nối kỹ thuật giữa 
14/12/2022 thông tin từ  Minh Than 1.0
BaseBS và
BaseBS và trả 
SkyJoy
thông tin về 
BaseBS

         

Bảng theo dõi thay đổi/ Document Track Changes – 4
Technical Document – BaseBS CRM Integration -

3 MỤC LỤC/ Table of Content
• TỔNG QUAN TÀI LIỆU/ Document Review
• Bảng Theo Dõi Thay Đổi/ Document Track Changes
• MỤC LỤC/ Table Of Content
• I. GIỚI THIỆU/ INTRODUCTION
• 1. Đối Tượng Sử Dụng/ Users:
• 2. Phạm Vi Áp Dụng/ Scope:
• 3. Mục Đích/ Purpose:
• 4. Giải Thích Từ Ngữ Và Từ Viết Tắt/ Word Definition And Abbreviation:
• 5. Tài Liệu Tham Khảo/ References
• 6. Cấu Trúc Tài Liệu/ Document Structure
• II. TIÊU CHUẨN TÍCH HỢP/ INTEGRATION STANDARDS
• 1. Mô Hình Tích Hợp/ Integration Model
• 2. Tiêu Chuẩn Kết Nối/ Connecting Standards
• 3. Hướng Dẫn Kết Nối/ Connecting Instruction
• 4. Hướng Dẫn Xác Thực/ Authentication Instruction
• 5. Tiêu Chuẩn Bảo Mật/ Security Standard
• III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE
• 1. Tên Miền/ Host:
• 2. API Get Token:
• 3. API Renew Token:
• 4. API Get User Info: (GET Method)
• 5. API Get User Info (POST Method)
• IV. NON-FUNCTIONAL REQUIREMENT
• VI. TIÊU CHUẨN CHẤT LƯỢNG/ QUALITY CONTROL STANDARDS

MỤC LỤC/ Table of Content – 5
Technical Document – BaseBS CRM Integration -

4 I. GIỚI THIỆU/ INTRODUCTION
4.1 1. Đối tượng sử dụng/ Users:
Tài liệu viết dành cho chuyên viên IT của BaseBS và SkyJoy.
Mục đích kết nối giữa 2 hệ thống, nhận và trả thông tin theo yêu cầu kinh doanh.

4.2 2. Phạm vi áp dụng/ Scope:
• Kết nối API giữa hệ thống của BaseBS và SkyJoy
• Kết quả mong muốn là BaseBS nhận lại thông tin đúng yêu cầu

4.3 3. Mục đích/ Purpose:

Tài liệu này được xây dựng nằm mô tả và phân tích mẫu thông tin kết nối từ BaseBS đến SkyJoy, cách 
thiết lập token cũng như renew token, cho dự án SkyJoy.
Tài liệu này được dùng làm vào đầu vào cho các quá trình thiết kế, xây dựng và xác thực token, theo 
các tiêu chuẩn kết nối đươc mô tả trong tài liệu này. Mục đích giúp bảo đảm an toàn và tin tưởng dữ 
liệu trong khi 2 hệ thống kết nối.
 

4.4 4. Giải thích từ ngữ và từ viết tắt/ Word definition and

Abbreviation:
Giải thích từ ngữ/ Word definition

  Word Definition

1 n/a  

Table I.4.1 - Giải thích từ ngữ/ Word definition

Giải thích từ viết tắt/ Abbreviation

  Abbreviation Description

1 n/a  

Table I.4.2 - Giải thích từ viết tắt/ Abbreviation

I. GIỚI THIỆU/ INTRODUCTION – 6
Technical Document – BaseBS CRM Integration -

4.5 5. Tài liệu tham khảo/ References

  References

1 n/a

Table I.5.1 - Danh sách tài liệu tham khảo/ References

4.6 6. Cấu trúc tài liệu/ Document structure

 
• Tiêu chuẩn kết nối: tổng quan phương thức kết nối, mô hình và luồng tích hợp/ Integration standards
• Hướng dẫn chi tiết và đặc tả API/ Detailed instructions and API specification
• Yêu cầu phi chức năng/ Non-functional requirements
• Tiêu chuẩn nghiệm thu/ Acceptance standards
 

I. GIỚI THIỆU/ INTRODUCTION – 7
Technical Document – BaseBS CRM Integration -

5 II. TIÊU CHUẨN TÍCH HỢP/ INTEGRATION STANDARDS

5.1 1. Mô hình tích hợp/ Integration Model
Hệ thống BaseBS kết nối với SkyJoy backend thông qua API

5.2 2. Tiêu chuẩn kết nối/ Connecting Standards

• Chuẩn kết nối/ Standard connection: HTTPS
• Phương thức xác thực/ Authentication method: Token
• Phương thức truyền dữ liệu/ Type of data transmission: JSON

5.3 3. Hướng dẫn kết nối/ Connecting Instruction

Hướng dẫn kết nối chi tiết trong mục III.1

5.4 4. Hướng dẫn xác thực/ Authentication Instruction

n/a

5.5 5. Tiêu chuẩn bảo mật/ Security Standard

n/a

II. TIÊU CHUẨN TÍCH HỢP/ INTEGRATION STANDARDS – 8
Technical Document – BaseBS CRM Integration -

6 III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE
6.1 1. Tên miền/ Host:
 

Service Env Domain

Auth Production Https://Id.skyjoy.vn

UAT Https://Api.uat.galaxyjoy.vn
Partner
Production Https://Api.skyjoy.vn

Table III.1.1 - Tham số yêu cầu của tên miền/ Request parameter of Domain

 

6.2 2. API Get Token:

 
• Request

Method URL

POST {{auth_host}}/realms/Loyalty-partner/protocol/openid-connect/token

Table III.2.1.1 - Tham số request của API Get Token/ Request parameter of API Get Token

• Header

Header Value

Content-Type application/x-www-form-urlencoded

Table III.2.1.2 - Tham số request của API Get Token/ Request parameter of API Get Token

 
• Body

Form field Type Value

client_id String <<provided by SkyJoy>>

client_secret String <<provided by SkyJoy>>

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 9
Technical Document – BaseBS CRM Integration -

grant_type String password

username String <<provided by SkyJoy>>

password String <<provided by SkyJoy>>

Table III.2.1.3 - Tham số request của API Get Token/ Request parameter of API Get Token

 
• Response

Http Code Response Note

{
"access_token": <<token_string>>,
"expires_in": 300,
"refresh_expires_in": 1800,
"refresh_token": <<refressh_token_string>>,
200  
"token_type": "Bearer",
"not-before-policy": 0,
"session_state": "5971a956-2d27-4aff-
bd23-17fecfbd8638",
"scope": "email profile"
}

Table III.2.2 - Tham số response của API Get Token/ Response parameter of API Get Token

 

6.3 3. API Renew Token:

 
• Request

Method URL

POST {{auth_host}}/realms/Loyalty-partner/protocol/openid-connect/token

Table III.3.1.1 - Tham số request của API Get Token/ Request parameter of API Get Token

• Header

Header Value

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 10
Technical Document – BaseBS CRM Integration -

Content-Type application/x-www-form-urlencoded

Table III.3.1.2 - Tham số request của API Get Token/ Request parameter of API Get Token

 
• Body

Form field Type Value

client_id String <<provided by SkyJoy>>

client_secret String <<provided by SkyJoy>>

grant_type String refresh_token

refresh_token String <<refresh_token_string>>

Table III.3.1.3 - Tham số request của API Get Token/ Request parameter of API Get Token

 
• Response

  Http Code Response Note

{
"access_token":
<<token_string>>,
"expires_in": 300,
"refresh_expires_in":
1800,
"refresh_token":
200    
<<refressh_token_string>>,
"token_type": "Bearer",
"not-before-policy": 0,
"session_state":
"5971a956-2d27-4aff-
bd23-17fecfbd8638",
"scope": "email profile"
}

Table III.3.2 - Tham số response của API Renew Token / Response parameter of API Renew Token

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 11
Technical Document – BaseBS CRM Integration -

6.4 4. API Get User Info: (GET Method)

 
• Request

Method URL

GET {{partner_host}}/api-user/partner/v1/user/?phone=<<phone_number>>

Table III.4.1.1 - Tham số request của API Get User Info - GET Method/ Request parameter of API Get User

Info - GET Method
• Header

Header Value

Content-Type application/json

Authorization Bearer <<token>>

Table III.4.1.2 - Tham số request của API Get User Info - GET Method/ Request parameter of API Get User

Info - GET Method
 
• Body

Form field Type Value

phone String Ex: +84987654321 | 0987654321

Table III.4.1.3 - Tham số request của API Get User Info - GET Method/ Request parameter of API Get User

Info - GET Method
 
• Response

Http Code Response Note

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 12
Technical Document – BaseBS CRM Integration -

{
"statusCode": 200,
"message": "SUCCESS",
"data": [
{
"id": "855ef16b-3c56-43c1-af5a-16d1745fe331", Tìm đúng số 
200 "fullName": "dat nguyen", điện thoại 
"email": "test@gmail.com", trả về 1 user
"phone": "+84987654321",
"status": "PENDING",
"memberCode": "SJ0817790612"
}
]
}

{
"message": "SUCCESS", Không tìm
200
"statusCode": 200, thấy user
"data": []
}

{ Định dạng 
"message": "invalid phone number", của số điện 
400
"statusCode": 400, thoại không 
"error": "Bad Request" hợp lệ
}

Table III.4.2 - Tham số request của API Get User Info - GET Method/ Request parameter of API Get User

Info - GET Method
 

6.5 5. API Get User Info (POST Method)

 
• Request

Method URL

POST  

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 13
Technical Document – BaseBS CRM Integration -

Table III.5.1.1 - Tham số request của API Get User Info - POST Method/ Request parameter of API Get

User Info - POST Method
• Header

Header Value

Content-Type  

Authorization  

Table III.5.1.2 - Tham số request của API Get User Info - POST Method/ Request parameter of API Get

User Info - POST Method
 
• Body

Form field Type Value

phone String  

Table III.5.1.3 - Tham số request của API Get User Info - POST Method/ Request parameter of API Get

User Info - POST Method
 
• Response

Http Code Response Note

{
"statusCode": 200,
"message": "SUCCESS",
"data": [
{
"id": "855ef16b-3c56-43c1-af5a-16d1745fe331", Tìm đúng số 
200 "fullName": "dat nguyen", điện thoại 
"email": "test@gmail.com", trả về 1 user
"phone": "+84987654321",
"status": "PENDING",
"memberCode": "SJ0817790612"
}
]
}

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 14
Technical Document – BaseBS CRM Integration -

{
"message": "SUCCESS", Không tìm
200
"statusCode": 200, thấy user
"data": []
}

{ Định dạng 
"message": "invalid phone number", của số điện 
400
"statusCode": 400, thoại không 
"error": "Bad Request" hợp lệ
}

Table III.5.2 - Tham số request của API Get User Info - POST Method/ Request parameter of API Get User

Info - POST Method

III. HƯỚNG DẪN KỸ THUẬT/ TECHNICAL GUIDE – 15
Technical Document – BaseBS CRM Integration -

7 IV. NON-FUNCTIONAL REQUIREMENT

n/a

IV. NON-FUNCTIONAL REQUIREMENT – 16

Technical Document – BaseBS CRM Integration -

8 VI. TIÊU CHUẨN CHẤT LƯỢNG/ QUALITY CONTROL 
STANDARDS
n/a

VI. TIÊU CHUẨN CHẤT LƯỢNG/ QUALITY CONTROL STANDARDS – 17