Splash Page API

API quản lý trang chào WIFI

Lấy danh sách trang chào

GET {{base_url}}/splash_pages

Cho phép lấy danh sách trang chào của một địa điểm

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm
type_page	string	Loại trang chào. Nếu truyền vào type_page sẽ lấy ra chi tiết thông tin của loại trang chào đó , nếu không truyền vào type_page sẽ lấy ra danh sách tất cả các trang chào

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200 Lấy ra danh sách trang chào

{
    "status": 200,
    "message": "List splash pages",
    "data": [

    ]
}

401 access_token không tồn tại

{
    "status_code": 401,
    "message": "access_token not found! Please contact CRMX at [e-mail] for help"
}

404 pos_id không tồn tại

{
    "status": 404,
    "status_code": 404,
    "message": "pos_id does not exist!"
}

Tên	Type_page
Trang đăng ký	register
Trang chào mặc định	default
Chúc mừng sinh nhật	birthday
Trang chào theo lượt đến	loyal
Trang chào theo tag	tag
Trang chào theo khung giờ	hour
Trang chào theo khoảng ngày	promotion
Trang khảo sát	survey

Tạo mới trang chào mặc định

POST {{base_url}}/splash_pages/default

Cho phép tạo mới trang chào mặc định

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>
Content-Type	string	multipart/form-data

Request Body

Name	Type	Description
photo	string	Ảnh trang chào
content	string	Nội dung ảnh
title	string	Tiêu đề ảnh
auto_popup	string	Trang popup tự động chuyển hướng sau khi đăng nhập
welcome_text	string	Lời chào khi kết nối WIFI
connect_button	string	Tên nút kết nối WIFI
ignore_register	string	Bỏ qua đăng ký ("True" or "False")
wifi_access_code	string	Yêu cầu nhập mã ("True" or "False")
wifi_access_code_default	string	Mã truy cập wifi mặc định
facebook_pixel_id	string	Pixel ID
facebook_pixel_code	string	Pixel code
google_pixel_code	string	Google remarketing code

200

{
    "status": 200,
    "status_code": 200,
    "message": "Success!"
}

400 Sai dữ liệu truyền vào

{
    "status": 400,
    "status_code": 400,
    "message": "Wrong data!"
}

401 access_token không tồn tại

{
    "status_code": 401,
    "message": "access_token not found! Please contact CRMX at [e-mail] for help"
}

404 pos_id không tồn tại

{
    "status": 404,
    "status_code": 404,
    "message": "pos_id does not exist!"
}

Lấy chi tiết thông tin trang chào mặc định

GET {{base_url}}/splash_pages/default

Cho phép lấy chi tiết thông tin trang chào mặc định

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200 Lấy ra danh sách trang chào

{
    "status": 200,
    "message": "Default splash page",
    "data": [
    
    ]
}

Cấu hình trang chào đăng ký

POST {{base_url}}/splash_pages/default

Cho phép cấu hình trang chào đăng ký

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>
Content-Type	string	application/json

Request Body

Name	Type	Description
name	string	Cấu hình trang đăng ký có yêu cầu họ và tên hay không, "True" or "False"
name_require	string	Bắt buộc người dùng phải nhập họ và tên hay có thể bỏ qua, "True" or "False"
email	string	Cấu hình trang đăng ký có yêu cầu email hay không, "True" or " False"
email_require	string	Bắt buộc người dùng phải nhập email hay có thể bỏ qua, "True" or "False"
birthday	string	Cấu hình trang đăng ký có yêu cầu ng sinh hay không, "True" or "False"
birthday_require	string	Bắt buộc người dùng phải nhập ngày sinh hay có thể bỏ qua, "True" or "False"
year_birthday	string	Cấu hình trang đăng ký có yêu cầu năm sinh hay không, "True" or "False"
year_birthday_require	string	Bắt buộc người dùng phải nhập năm sinh hay có thể bỏ qua, "True" or "False"
gender	string	Cấu hình trang đăng ký có yêu cầu giới tính hay không, "True" or "False"
gender_require	string	Bắt buộc người dùng phải nhập giới tính hay có thể bỏ qua, "True" or "False"
welcome_text	string	Lời chào mời đăng ký
birthday_text	string	Lời chào mời nhập sinh nhật
welcome_button	string	Tên nút kết nối
otp	string	Sử dụng otp khi đăng ký, "True" or "False"

200

{
    "status": 200,
    "status_code": 200,
    "message": "Success!"
}

400

{
    "status": 400,
    "status_code": 400,
    "message": "Wrong data!"
}

401

{
    "status_code": 401,
    "message": "access_token not found! Please contact CRMX at [e-mail] for help"
}

404

{
    "status": 404,
    "status_code": 404,
    "message": "pos_id does not exist!"
}

Lấy chi tiết thông tin trang chào đăng ký

GET {{base_url}}/splash_pages/register

Cho phép lấy chi tiết thông tin trang chào đăng ký

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200

Xóa ảnh trong trang chào mặc định

DELETE {{base_url}}/splash_pages/default

Cho phép xóa ảnh trong trang chào mặc định

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm

Headers

Name	Type	Description
Content-Type	string	multipart/form-data
Authorization	string	Bearer <access_token>

Request Body

Name	Type	Description
card_id	string	id ảnh trang chào

200

{
    "status": 200,
    "message": [
        {
            "message": "Detele success!",
            "card_id": "5d960c99a066db1615fbbf40",
            "isError": false
        },
        {
            "message": "Card does not exist!",
            "card_id": "5d960c99a066db1615fbbf3e",
            "isError": true
        }
    ]
}

400

{
    "status": 400,
    "message": "key must be card_id"
}

404

{
    "status_code": "404",
    "message": "pos_id does not exist!"
}

Update ảnh trang chào mặc định

PUT {{base_url}}/splash_pages/default/card

Cho phép update ảnh trang chào mặc định

Query Parameters

Name	Type	Description
card_id	string	id ảnh
pos_id	string	id địa điểm

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>
Content-Type	string	multipart/form-data

Request Body

Name	Type	Description
photo	string	Ảnh trang chào
content	string	Nội dung ảnh
title	string	Tiêu đề ảnh

200