Member API

API quản lý thành viên

Lấy thông tin thành viên của một địa điểm

GET {{base_url}}/customers_location

Cho phép lấy thông tin thành viên của một địa điểm (shop, cửa hàng, nhà hàng...) theo số điện thoại

Query Parameters

Name	Type	Description
shop_id	string	id địa điểm
pos_id	string	i​d địa điểm
phone	string	Số điện thoại

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200 Lấy thành công thông tin thành viên

{
    "status": 200,
    "message": "Customer info",
    "data": {
        "_id": "5d8c353a7c857b43b4eff3ae",
        "age_range": "",
        "year_birthday": "1996",
        "home_town": "Ha Noi",
        "twitter": "",
        "gender": "1",
        "created_at": "26-09-2019",
        "fb_id": "152134088",
        "phone": "0945350398",
        "birthday": "05-30",
        "facebook": "https://vi-vn.facebook.com/nextifyvn",
        "address": "Phao Dai Lang",
        "relationship_status": "Chua ket hon",
        "client_mac": [],
        "email": "[e-mail]",
        "name": "Ly Tu Quang Thang",
        "updated_at": "26-09-2019"
}

401 access_token không tồn tại

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

404 pos_id does không tồn tại

{
    "status": 404,
    "status_code": 404,
    "message": "Customer not found!"
}

Lưu ý:

• Bắt buộc phải truyền shop_id hoặc pos_id

• Lấy shop_id qua Merchant API

curl -X GET \
  '{{ base_url }}/customers_location?shop_id={{ shop_id }}&phone={{ phone }}' \
  -H 'Authorization: Bearer {{ access_token }}'

Lấy thông tin thành viên của Merchant

GET {{ base_url }}/customers

Cho phép lấy thông tin thành viên của Merchant theo số điện thoại

Query Parameters

Name	Type	Description
merchant_id	string	id merchant
phone	string	số điện thoai

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200 Thành công

{
    "status": 200,
    "message": "Customer info",
    "data": {
        "_id": "5d8c353a7c857b43b4eff3ae",
        "age_range": "",
        "year_birthday": "1996",
        "home_town": "Ha Noi",
        "twitter": "",
        "gender": "1",
        "created_at": "26-09-2019",
        "fb_id": "152134088",
        "phone": "0945350398",
        "birthday": "05-30",
        "facebook": "https://vi-vn.facebook.com/nextifyvn",
        "address": "Phao Dai Lang",
        "relationship_status": "Chua ket hon",
        "client_mac": [],
        "email": "[e-mail]",
        "name": "Ly Tu Quang Thang",
        "updated_at": "26-09-2019"
}

Lưu ý:

- Lấy merchant_id qua Partner API

curl -X GET \
  '{{ base_url }}/customers?merchant_id={{ merchant_id }}&phone={{ phone }}' \
  -H 'Authorization: Bearer {{ access_token }}'

Tạo mới thành viên

POST {{base_url}}/customers_location

Cho phép tạo mới thành viên vào một địa điểm

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	Họ và tên
phone	string	Số điện thoại
email	string	Email
company	string	Công ty
company_role	string	Vị trí trong công ty
gender	string	Giới tính (nam: 1, nữ: 2)
birthday	string	Sinh nhật (mm-dd)
year_birthday	string	Năm sinh
address	string	Địa chỉ
note	string	id facebook
facebook	string	Link facebook cá nhân
twitter	string	Link twitter cá nhân

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

{
    "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 Nextify 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!"
}

409 Thành viên đã tồn tại

{
    "status": 409,
    "status_code": 409,
    "message": "Customer already exist!"
}

Lưu ý:

- Bắt buộc phải truyền vào phone hoặc email

Thay đổi thông tin thành viên

PUT {{base_url}}/customers_location

Query Parameters

Name	Type	Description
pos_id	string	id địa điểm
phone	string	Số điện thoại

Headers

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

Request Body

Name	Type	Description
name	string	Họ và tên
email	string	Email
gender	string	Giới tính (nam: 1, nữ: 2)
relationship_status	string	Trạng thái hôn nhân
birthday	string	Sinh nhật (mm-dd)
year_birthday	string	Năm sinh
home_town	string	Quê quán
address	string	Địa chỉ
fb_id	string	id facebook
facebook	string	Link facebook cá nhân
twitter	string	Link twitter cá nhân

200 Thay đổi thông tin khách hàng thành công

{
    "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 Nextify at [e-mail] for help"
}

404 Khách hàng chưa tồn tại, vui lòng tạo mới khách hàng

{
    "status": 404,
    "status_code": 404,
    "message": "Customer not found! Please create new customer!"
}

Tạo mới thành viên ( theo địa chỉ mac )

POST {{ base_url }}/customers_mac

cho phép tạo mới thành viên tại một địa điểm

Query Parameters

Name	Type	Description
gateway_mac	string	địa chỉ MAC thiết bị của địa điểm

Headers

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

Request Body

Name	Type	Description
name	string	họ và tên người dùng
email	string	địa chỉ email người dùng
address	string	địa chỉ người dùng
phone	string	số điện thoại người dùng
client_mac	string	địa chỉ MAC của người dùng

200

Tạo tag cho khách hàng

POST {{base_url}}/customers/tags

Cho phép tạo và chỉnh sửa tag cho khách hàng

Query Parameters

Name	Type	Description
merchant_id_app	string	id merchant
phone	string	Số điện thoại khách hàng
tag_id	string	id tag ( danh sách tag trong phần tag API )

Headers

Name	Type	Description
Authorization	string	Bearer <access_token>

200