WifiProfile API

API quản lý wifi profile

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

GET {{base_url}}/wifi_profiles

Cho phép lấy danh sách wifi profile của merchant

Query Parameters

Name	Type	Description
merchant_slug	string	tên merchant
page	string	trang hiện tại
page_limit	string	giới hạn số bản ghi trả về

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200 Success

{
    "status": 200,
    "message": "page: 1, page_limit: 3, total shops: 3",
    "data": [
        
        ]
}

401 access token not found

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

404 merchant_slug là bắt buộc

{
    "status": 404,
    "message": "merchant_slug required!"
}

Tạo mới Wifi Profile

POST {{ base_url }}/wifi_profiles

Cho phép tạo mới wifi profile

Query Parameters

Name	Type	Description
merchant_id_app	string	id merchant

Headers

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

Request Body

Name	Type	Description
name	string	Tên profile
session_timeout	string	Thời gian truy cập(phút)
down_bw	string	Tốc độ download(MBps)
up_bw	string	Tốc độ upload(MBps)
pricing	string	Giá cước
profile_type	string	Hình thức profile - Default: mặc định - AddOn: tính phí
tags	array	Nhóm khách hàng
active	string	KÍch hoạt ( True hoặc False )
expire	string	Hạn truy cập ( tiếng )

200 Tạo mới thành công

{
  "status": 200,
  "message": "Success!",
  "data": {
    "profile_id": "5e25c75b4f89b4656837924d"
  }
}

404

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"
}'

Update Wifi Profile

PUT {{ base_url }}/wifi_profiles

Cho phép update wifi profile

Query Parameters

Name	Type	Description
merchant_id_app	string	id địa điểm
profile_id	string	id profile

Headers

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

Request Body

Name	Type	Description
name	string	Tên profile
session_timeout	string	Thời gian truy cập(phút)
down_bw	string	Tốc độ download(MBps)
up_bw	string	Tốc độ upload(MBps)
pricing	string	Giá cước
profile_type	string	Hình thức profile
tags	array	Nhóm khách hàng
active	string	Kích hoạt (True hoặc False)
expire	string	Hạn truy cập (tiếng)

200 Update thành công

{
  "status": 200,
  "message": "Success!",
  "data": {
    "profile_id": "5e25c75b4f89b4656837924d"
  }
}

400

{
    "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"
}'