Tích hợp gọi API khi tạo User mới & Tag và lấy info

1. Api cho phép bạn tạo/ cập nhật khách hàng qua salekit.com

1.1. Lưu thông tin 1 Contact

Sử dụng phương thức POST với URL và các tham số như dưới đây:

Tất cả các request đến API service sẽ được xác thực theo giá trị "Token" trong header của request

Lấy giá trị Token tại đây 

  • Header

Key Value
Content-Type application/json
Token TOKEN

  • Tạo và lưu thêm tham số mới

- Cần tạo Custom Attribute (biến tùy chỉnh)

- Trong CRM -> chọn Trường dữ liệu -> Thêm trường -> Lưu 

* Lưu ý: Biến phải trùng với biến khai báo bên ZNS (Nếu bạn muốn gửi ZNS kèm theo các biến tạo mới). 

  • Nội dung param

Tên tham số Kiểu dữ liệu Bắt buộc Mô tả
full_name String Có

Họ tên khách hàng

VD: Nguyễn Văn A

email String Có

Email khách hàng

VD: [email protected]

phone String Không

Số điện thoại khách hàng

VD: 0989123456

tag String Không

Tag khách hàng (nếu chưa có sẽ tự tạo mới)

VD: Đã mua, Khách hàng mới, ...

src String Không

Nguồn:

VD: chatbot

cid String không

Ai giới thiệu

Ví dụ ?cid=8a3dfbc1

(Chính là link affiliate)

un_tag String Không

Tag muốn hủy:

VD: Đã mua, Khách hàng mới, ...

gender String Không

Giới tính:

VD: Nam hoặc Nữ

address String Không

Địa chỉ:

VD: Cầu Giấy - Hà Nội

note String Không

Ghi chú:

VD: Khách hàng mới

custom_field  object Không

chứa các biến custom

VD :  {"madon":"12345" }

type integer Không

Loại khách hàng:

0: Customer

1: VIP

2: Lead

3: Partner

4: Reseller

5: Competitor

6: Affiliate

7: Other

Định dạng dữ liệu mẫu Api chứa data là chuỗi json:

{
    "full_name": "Khách hàng 01",
    "email": "[email protected]",
    "phone": "0985666555",
    "tag": "salekit.com"
}

  • Response

Tham số Giá trị
error false
msg Thành công

  • Code mẫu

curl --location --request POST 'https://api.salekit.io/api/v1/audience/create' 
--header 'Token: eyJ0eXAiOiJqd3QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOiIyMDIxLTEyLTE2VDEzOjU0OjA1KzA3MDAiLCJzaG9wX2lkIjoiYzllMTA3NGY1YjNmOWZjOGVhMTVkMTUyYWRkMDcyOTQifQ.LFXoO44-6iiCjniukh3RSOu_yKSKy8oUcYlqDdbWFMM' 
--header 'Content-Type: application/json' 
--header 'Cookie: ci_session=ql0qo1u9jf7p37k8pviq9a3m30372dke' 
--data-raw '{
    "full_name": "Khách hàng 01",
    "email": "[email protected]",
    "phone": "0985666555"
}'

1.2. Lưu thông tin nhiều contact

Lưu nhanh thông tin một mảng danh sách Contact truyền các tham số sau:

[ {customer1}, {customer2},.. ]
Trong đó {customer1}, {customer2} là mảng dữ liệu của 1 Contact cần thêm ở bước 1.1
Tối đa 50 khách hàng/ request
  • Code mẫu
curl --location 'https://api.salekit.io/api/v1/audience/create' \
--header 'Token: eyJ0eXAiOiJqd3QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOiIyMDIzLTEwLTE3VDA5OjA5OjA3KzA3MDAiLCJzaG9wX2lkIjoiMmEzOGE0YTkzMTZjNDllNWE4MzM1MTdjNDVkMzEwNzAifQ.yg-R9iyD94kkrOrFD9PANQpeBRRhkJorYxJzLr0D_V8' \
--header 'Content-Type: application/json' \
--header 'Cookie: ci_session=jf39d43aem9ja7e94bsetpf5ndfsfhsi' \
--data-raw '[
    {
        "full_name": "Demo",
        "email": "[email protected]",
        "phone": "0989123456",
        "note": "Ghi chú"
    },
    {
        "full_name": "Demo2",
        "email": "[email protected]",
        "phone": "0989123457",
        "note": "Ghi chú2"
    }
]'

2. Lấy thông tin chi tiết khách hàng

Sử dụng phương thức GET với URL và các tham số như dưới đây:

https://api.salekit.io/api/v1/contact/get?phone=xxx&email=yyy&token

Lấy giá trị Token tại đây

  • Nội dung param

Tên tham số Kiểu dữ liệu Bắt buộc Mô tả
token String Có

Token kết nối với Shop

email String Có/Không

Email khách hàng

Nếu không có phone thì email là bắt buộc

phone String Có/Không

Số điện thoại khách hàng

Nếu không có email thì phone là bắt buộc

  • Response

Tham số Giá trị
error false
msg Thành công
status 200
data

Mảng thông tin khách hàng

  • Code mẫu

curl --location 'https://api.salekit.io/api/v1/contact/get?phone=0912345678&email=abc%40gmail.com&token=Azbsdsdgfzzzz' 
--header 'Cookie: ci_session=22f4df811399c517f70211351679fee55fad5b0c'