Tổng quan MiniApp SDK
Giới thiệu
Zalopay MiniApp SDK cung cấp các chức năng để ứng dụng Web của Đối Tác tương tác trực tiếp hoặc cung cấp thông tin về mặt điều hướng, giao diện, thông tin người dùng,… trên ứng dụng Zalopay, và MiniApp Zalopay trên ứng dụng Zalo.
Tài liệu này có sử dụng một số thuật ngữ sau:
- zpa(Zalopay App): Chức năng chỉ có thể được sử dụng ở ứng dụng Zalopay trên cả 2 nền tảng Android và iOS
- zpi(Zalopay Integration in Zalo App): Chức năng chỉ có thể được sử dụng ở miniapp Zalopay trong ứng dụng Zalo
- android: Chức năng chỉ có thể được sử dụng ở ứng dụng Zalopay trên nền tảng Android
- ios: Chức năng chỉ có thể được sử dụng ở ứng dụng Zalopay trên nền tảng iOS
Hướng dẫn tích hợp và sử dụng
- Ứng dụng đối tác tích hợp SDK qua CDN như sau:
<!-- Môi trường SandboxQC -->
<script src="https://qcmp.zalopay.vn/v1/mp/sdk/js-sdk.js?platform=iframe"></script>
<!-- Môi trường Staging -->
<script src="https://stgmp.zalopay.vn/v1/mp/sdk/js-sdk.js?platform=iframe"></script>
<!-- Môi trường Production -->
<script src="https://mp.zalopay.vn/v1/mp/sdk/js-sdk.js?platform=iframe"></script>
- Sử dụng MiniApp SDK:
// Ứng dụng đối tác sử dụng các chức năng của SDK theo format: window.zlpSdk.[Category].[Function](params)
// Ví dụ: Hàm setTitle
window.zlpSdk.UI.setTitle({ title: "Zalo Pay" })
.then((response) => console.log(response))
.catch((error) => console.error(error));
// Output: { data: {}, status: "success" }
// Error: { status: "error", errorCode: "000001", errorMessage: "An unknown error occurred" }
- Các mã lỗi thường gặp:
Bảng mô tả các mã lỗi thường gặp khi gọi các chức năng SDK nói chung:
| Mã lỗi | Mô tả |
|---|---|
| 000000 | Lỗi tham số truyền vào không hợp lệ |
| 000001 | Lỗi không xác định |
| 000002 | Chức năng chưa được hỗ trợ |
| 000003 | Chức năng không được cấp quyền |
| 000004 | App Id không hợp lệ |
Cấp quyền sử dụng chức năng
Để có thể sử dụng một số chức năng của Zalopay MiniApp SDK, Đối Tác cần gửi yêu cầu cấp quyền đến đội ngũ Zalopay.
Hướng dẫn chạy ứng dụng mẫu sử dụng MiniApp SDK
- Sử dụng ứng dụng mẫu ở ZPA (Zalopay App): Dùng deeplink zalopay://launch/app/999 ở điện thoại
- Sử dụng ứng dụng mẫu ở ZPI (Zalopay Integration in Zalo App): Dùng url https://socialdev.zalopay.vn/spa/v2/sample-app ở ứng dụng Zalo
Ứng dụng kiểm thử
Đối tác có thể tải các phiên bản khác nhau của ứng dụng Zalopay thử nghiệm tại Trang Ví Kiểm thử