Hướng dẫn sử dụng API Của ZNS ATP Care

1, ZNS ATP Care bao gồm nhưng API Public nào

Hiện ZNS ATP Care đang hỗ trợ các API sau:

• Lấy danh sách OA của 1 tài khoản: (GET) https://zns.atpcare.vn/api/get-oa-user?token={{API_KEY}}
• Lấy danh sách template của 1 tài khoản: (GET) https://zns.atpcare.vn/api/get-list-template?token={{API_KEY}}
• Lấy thông tin của template: (GET) https://zns.atpcare.vn/api/get-template-info?id={{template_id}}&oa_id={{oa_id}}&token={{API_KEY}}
• Gửi ZNS: (POST) https://zns.atpcare.vn/api/send-zns

2, Hướng dẫn sử dụng các API

{{API_KEY}}: đây là Access Token của tài khoản tại https://zns.atpcare.vn

Để lấy ra được Access Token chúng ta truy cập vào màn hình Quản Lý API tại https://zns.atpcare.vn/dashboard/apimanager

Access Token sẽ xuất hiện ở đây, nếu chưa có hãy bấm tạo 1 Access Token mới nhé

2.1 Lấy danh sách OA của 1 tài khoản:

Thực hiện gửi GET request tới URL: https://zns.atpcare.vn/api/get-oa-user?token={{API_KEY}}

Nếu lấy thành công kết quả sẽ trả ra như dưới hình

2.2 Lấy danh sách template của 1 tài khoản:

Thực hiện gửi GET request tới URL: https://zns.atpcare.vn/api/get-list-template?token={{API_KEY}}

Nếu lấy thành công kết quả sẽ trả ra như dưới hình

3, Lấy thông tin của template:

Thực hiện gửi GET request tới URL: https://zns.atpcare.vn/api/get-template-info?id={{template_id}}&oa_id={{oa_id}}&token={{API_KEY}}

{{template_id}}: id của template muốn thực hiện lấy thông tin

{{oa_id}}: id của OA đang quản lý template này

Để lấy được 2 thông tin này ta thực hiện vào màn hình Quản Lý API -> Chọn Template muốn lấy thông tin 

Sau khi gửi request thành công với thông tin trên kết quả sẽ trả ra thông tin của template:

4, Gửi ZNS:

Thực hiện gửi POST request tới URL: https://zns.atpcare.vn/api/send-zns

Nếu chúng ta có các param của 1 template để gửi rồi thì mình sẽ gắn trực tiếp vào API này để thực hiện gửi ZNS, nếu chưa thì có thể chạy API lấy thông tin của template từ đó lấy ra listParams để sử dụng cho API này

URL: https://zns.atpcare.vn/api/send-zns

Header

access-token:{{API_KEY}}

Content-Type: application/json

Body:

Lưu ý:

– Đây là param mẫu, hãy thay đổi lại các param cho phù hợp với template

– phone là trường bắt buộc phải có

{

  “phone”: “0775999345”,

  “oa_id”: “416248746938903306”,

  “template_id”: “310477”,

  “CustomerName”: “Hiếu”,

  “Code”: “72374”,

  “PurchaseDate”: “25/01/2024”,

  “Total”: “1000000”,

  “TotalPayment”: “1000000”

}

Nếu gửi thành công thì API sẽ trả ra kết quả như hình:

Trên đây là danh sách cũng như hướng dẫn sử dụng API của ZNS ATP Care, cảm ơn quý đối tác và khách hàng đã luôn tin tưởng sử dụng giải pháp của chúng tôi. Nếu có thắc mắc nào hãy liên hệ cho đội ngũ hỗ trợ của ATP Care để được hỗ trợ