Giới Thiệu
Zalo Mini App API cung cấp các api để bạn tương tác với ứng dụng Zalo. Một số API yêu cầu bạn gửi xét duyệt trước khi được sử dụng.
mẹo
Với tài khoản là Admin của Ứng dụng, bạn có thể sử dụng toàn bộ các API trong quá trình phát triển ứng dụng mà không cần đợi xét duyệt.
Cài Đặt
npm install zmp-sdk
Events API
| Tên | Mô tả |
|---|---|
| on | Thêm một hàm xử lý cho sự kiện. Khi sự kiện xảy ra, tất cả các hàm xử lý của sự kiện đó sẽ được gọi |
| once | Thêm hàm xử lý một lần cho sự kiện. Khi sự kiện xảy ra, hàm xử lý này sẽ bị xoá và sau đó thực thi |
| off | Xoá một hàm xử lý cụ thể trong mảng các hàm xử lý của sự kiện |
| removeAllListeners | Xoá tất cả hàm xử lý của sự kiện |
| onConfirmToExit | Dùng để lắng nghe sự kiện khi user nhấn đóng mini app |
| offConfirmToExit | Hủy nghe sự kiện user nhấn đóng mini app |
| onNetworkStatusChange | Dùng để lắng nghe sự kiện thay đổi mạng |
Events Name
| Tên | Mô tả |
|---|---|
| AppPaused | Sự kiện này xảy ra khi Zalo Mini App chuyển từ foreground sang background |
| AppResumed | Sự kiện này xảy ra khi Zalo Mini App chuyển từ background sang foreground |
| NetworkChanged | Sự kiện này xảy ra khi phát hiện thay đổi kết nối mạng |
| OnDataCallback | Sự kiện này xảy ra khi nhận được data từ Mini App được mở trước đó |
| OpenApp | Sự kiện này xảy ra khi Zalo Mini App được mở lại từ chế độ nền (chưa tắt hẳn) |
User
Authorization
| Tên | Mô tả |
|---|---|
| authorize | Cấp quyền sử dụng API |
User Information
| Tên | Mô tả |
|---|---|
| getUserID | Lấy ID của người dùng |
| getUserInfo | Lấy thông tin của người dùng |
| getAccessToken | Lấy token dùng để định danh người dùng |
| getPhoneNumber | Lấy thông tin số điện thoại của người dùng |
User Settings
| Tên | Mô tả |
|---|---|
| getSetting | Lấy thông tin cài đặt hiện tại của người dùng. |
Basic
| Tên | Mô tả |
|---|---|
| getAppInfo | Lấy thông tin của Zalo Mini App |
| getSystemInfo | Lấy thông tin của Zalo App và thiết bị |
| getDeviceIdAsync | Lấy chuỗi định danh duy nhất cho từng thiết bị. |
| getContextAsync | Lấy thông tin về ngữ cảnh mà Zalo Mini App được mở |
Routing
| Tên | Mô tả |
|---|---|
| closeApp | Đóng mini app |
| openMiniApp | Mở mini app |
| openWebview | Mở webview |
| sendDataToPreviousMiniApp | Gửi dữ liệu cho mini app trước đó |
| getRouteParams | Lấy các param được gửi đến trang hiện tại của mini app |
Data Caching
| Tên | Mô tả |
|---|---|
| setStorage | Lưu trữ dữ liệu xuống bộ đệm. Dữ liệu sẽ được lưu ở thiết bị của người dùng. |
| getStorage | Lấy dữ liệu đã lưu ở bộ đệm |
| removeStorage | Xóa dữ liệu đã lưu ở bộ đệm |
| clearStorage | Xóa tất cả dữ liệu đã lưu ở bộ đệm |
| getStorageInfo | Lấy thông tin bộ đệm |
UI
Feedback
| Tên | Mô tả |
|---|---|
| showToast | Hiển thị toast và tự ẩn sau 1 khoảng thời gian |
| closeLoading | Tắt màn hình Splash Loading |
View
| Tên | Mô tả |
|---|---|
| configAppView | Ẩn/ hiện, tuỳ chỉnh màu sắc, kiểu hiển thị của status bar, action bar, bottom navigation (Android) / safe area inset bottom (iOS) |
| setNavigationBarColor | Đặt lại màu thanh điều hướng của trang hiện tại |
| setNavigationBarLeftButton | Đặt lại nút bên trái (Home, Back) trên thanh điều hướng của trang hiện tại |
| setNavigationBarTitle | Đặt lại tiêu đề trên thanh điều hướng của trang hiện tại |
Keyboard
| Tên | Mô tả |
|---|---|
| hideKeyboard | Ẩn bàn phím |
Location
| Tên | Mô tả |
|---|---|
| getLocation | Lấy vị trí hiện tại của người dùng |
Media
| Tên | Mô tả |
|---|---|
| checkZaloCameraPermission | Cho phép ứng dụng kiểm tra quyền truy cập camera của Zalo |
| requestCameraPermission | Cho phép ứng dụng yêu cầu device cấp quyền truy cập camera |
| chooseImage | Chọn hình ảnh từ album hoặc camera |
| openMediaPicker | Mở cửa sổ chọn media (camera, ảnh, file, video) từ thiết bị |
| saveImageToGallery | Lưu ảnh vào thư viện ảnh của thiết bị |
Device
Network
| Tên | Mô tả |
|---|---|
| getNetworkType | Lấy thông tin kết nối mạng |
Contact
| Tên | Mô tả |
|---|---|
| openPhone | Mở ứng dụng gọi điện thoại của thiết bị |
| openSMS | Mở ứng dụng tin nhắn của thiết bị |
Screen
| Tên | Mô tả |
|---|---|
| keepScreen | Giữ màn hình luôn bật |
Vibrate
| Tên | Mô tả |
|---|---|
| vibrate | Kích hoạt chế độ rung của thiết bị |
Biometric Authentication
| Tên | Mô tả |
|---|---|
| openBioAuthentication | Mở giao diện đăng nhập sinh trắc học |
| checkStateBioAuthentication | Kiểm tra thông tin xác thực sinh trắc học |
Permission
| Tên | Mô tả |
|---|---|
| requestSendNotification | Yêu cầu người dùng cho phép ứng dụng gửi thông báo qua OA Mini App |
| openPermissionSetting | Mở cửa sổ cài đặt quyền mà người dùng đã cấp cho ứng dụng |
Zalo
| Tên | Mô tả |
|---|---|
| openProfile | Mở màn hình thông tin của người dùng hoặc Official Account |
| openProfilePicker | Mở cửa sổ chọn bạn bè trong Zalo |
| openChat | Mở cửa sổ nhắn tin với người dùng hoặc Official Account |
| followOA | Theo dõi Official Account |
| unfollowOA | Bỏ theo dõi Official Account |
| openShareSheet | Mở cửa sổ chia sẻ trong Zalo |
| openPostFeed | Mở cửa sổ chia sẻ lên nhật ký trong Zalo |
| createShortcut | Tạo shorcut của mini app trên màn hình thiết bị |
| viewOAQr | Hiển thị QR code của Official Account |
| requestUpdateZalo | Chủ động điều hướng người dùng tới AppStore/CH Play để cập nhật phiên bản Zalo mới nhất |
| minimizeApp | Thu nhỏ mini app |
| favoriteApp | Thêm ứng dụng vào danh sách ưa thích ở Mini Store |
| addRating | Mở cửa sổ đánh giá ứng dụng |