WifiProfile API

API quản lý wifi profile

get
Lấy danh sách WifiProfile của merchant

{{base_url}}/wifi_profiles
Cho phép lấy danh sách wifi profile của merchant
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Query Parameters
merchant_slug
required
string
tên merchant
page
optional
string
trang hiện tại
page_limit
optional
string
giới hạn số bản ghi trả về
Response
200: OK
Success
{
"status": 200,
"message": "page: 1, page_limit: 3, total shops: 3",
"data": [
]
}
401: Unauthorized
access token not found
{
"status_code": "401",
"message": "access_token not found! Please contact Nextify at [email protected] for help"
}
404: Not Found
merchant_slug là bắt buộc
{
"status": 404,
"message": "merchant_slug required!"
}

post
Tạo mới Wifi Profile

{{ base_url }}/wifi_profiles
Cho phép tạo mới wifi profile
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Content-Type
required
string
application/json
Query Parameters
merchant_id_app
required
string
id merchant
Body Parameters
name
required
string
Tên profile
session_timeout
required
string
Thời gian truy cập(phút)
down_bw
required
string
Tốc độ download(MBps)
up_bw
required
string
Tốc độ upload(MBps)
pricing
optional
string
Giá cước
profile_type
optional
string
Hình thức profile - Default: mặc định - AddOn: tính phí
tags
optional
array
Nhóm khách hàng
active
optional
string
KÍch hoạt ( True hoặc False )
expire
optional
string
Hạn truy cập ( tiếng )
Response
200: OK
Tạo mới thành công
{
"status": 200,
"message": "Success!",
"data": {
"profile_id": "5e25c75b4f89b4656837924d"
}
}
404: Not Found
curl -X POST \
'{{ base_url }}/wifi_profiles?merchant_id_app={{ merchant_id_app }}' \
-H 'Authorization: Bearer {{ access_token }}' \
-H 'Content-Type: application/json' \
-d '{
"name": "vip1",
"session_timeout": "40",
"down_bw": "5",
"up_bw": "2",
"profile_type": "Default",
"tags": [
"{{ id_tag }}"
]
"active": "True",
"expire": "4"
}'

put
Update Wifi Profile

{{ base_url }}/wifi_profiles
Cho phép update wifi profile
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token>
Content-Type
required
string
application/json
Query Parameters
merchant_id_app
required
string
id địa điểm
profile_id
required
string
id profile
Body Parameters
name
optional
string
Tên profile
session_timeout
optional
string
Thời gian truy cập(phút)
down_bw
optional
string
Tốc độ download(MBps)
up_bw
optional
string
Tốc độ upload(MBps)
pricing
optional
string
Giá cước
profile_type
optional
string
Hình thức profile
tags
optional
array
Nhóm khách hàng
active
optional
string
Kích hoạt (True hoặc False)
expire
optional
string
Hạn truy cập (tiếng)
Response
200: OK
Update thành công
{
"status": 200,
"message": "Success!",
"data": {
"profile_id": "5e25c75b4f89b4656837924d"
}
}
400: Bad Request
{
"status": 404,
"message": "profile already exists!"
}
curl -X PUT \
'{{ base_url }}/wifi_profiles?merchant_id_app={{ merchant_id_app }}&profile_id={{ profile_id }}' \
-H 'Authorization: Bearer {{ access_token }}' \
-H 'Content-Type: application/json' \
-d '{
"name": "vip4",
"session_timeout": "40",
"down_bw": "5",
"up_bw": "2",
"profile_type": "Default",
"active": "True",
"expire": "4"
}'