Zalo Mini App API là bộ công cụ giúp nhà phát triển kết nối Mini App với các tính năng có sẵn trong hệ sinh thái Zalo. Thông qua API, ứng dụng có thể lấy thông tin người dùng, truy cập vị trí, camera, bộ nhớ thiết bị, mở cửa sổ chat, chia sẻ nội dung hoặc thực hiện nhiều thao tác khác ngay trong Zalo. Trong bài viết này, Abenla sẽ tổng hợp các nhóm Zalo Mini App API phổ biến, cách cài đặt SDK và những lưu ý quan trọng khi tích hợp API vào dự án.

Cài đặt Zalo Mini App API

Để sử dụng Zalo Mini App API trong dự án, nhà phát triển cần cài đặt ZMP SDK bằng lệnh sau:

npm install zmp-sdk

Sau khi cài đặt, bạn có thể import và sử dụng các API phù hợp với nhu cầu của Mini App.

Events API trong Zalo Mini App

Events API hỗ trợ nhà phát triển lắng nghe và xử lý các sự kiện xảy ra trong quá trình người dùng sử dụng Mini App.

API	Mô tả	Ghi chú
on	Thêm hàm xử lý cho một sự kiện. Khi sự kiện xảy ra, tất cả hàm xử lý đã đăng ký sẽ được gọi.
once	Thêm hàm xử lý chỉ chạy một lần. Sau khi sự kiện xảy ra, hàm sẽ tự động bị xóa.
off	Xóa một hàm xử lý cụ thể khỏi danh sách hàm của sự kiện.
removeAllListeners	Xóa toàn bộ hàm xử lý của một sự kiện.
onConfirmToExit	Lắng nghe sự kiện người dùng nhấn đóng Mini App.	Ngừng hỗ trợ
offConfirmToExit	Hủy lắng nghe sự kiện người dùng nhấn đóng Mini App.	Ngừng hỗ trợ
onNetworkStatusChange	Lắng nghe sự thay đổi trạng thái kết nối mạng.

Danh sách sự kiện phổ biến

Tên sự kiện	Mô tả
AppPaused	Xảy ra khi Zalo Mini App chuyển từ trạng thái foreground sang background.
AppResumed	Xảy ra khi Zalo Mini App chuyển từ background sang foreground.
NetworkChanged	Xảy ra khi phát hiện có sự thay đổi kết nối mạng.
OnDataCallback	Xảy ra khi Mini App nhận dữ liệu từ Mini App được mở trước đó.
OpenApp	Xảy ra khi Zalo Mini App được mở lại từ chế độ nền nhưng chưa đóng hoàn toàn.

User API: Xác thực và thông tin người dùng

Nhóm User API của Zalo Mini App giúp ứng dụng xác thực người dùng và lấy các thông tin cần thiết trong quá trình sử dụng.

Authorization API

API	Mô tả
authorize	Cấp quyền sử dụng API.

User Information API

API	Mô tả
getUserID	Lấy ID của người dùng.
getUserInfo	Lấy thông tin người dùng.
getAccessToken	Lấy token định danh người dùng.
getPhoneNumber	Lấy số điện thoại của người dùng sau khi được cấp quyền.

User Settings API

API	Mô tả
getSetting	Lấy thông tin cài đặt quyền hiện tại của người dùng.

Basic API trong Zalo Mini App

Basic API hỗ trợ lấy các thông tin cơ bản về Mini App, thiết bị và ngữ cảnh mà người dùng mở ứng dụng.

API	Mô tả
getAppInfo	Lấy thông tin của Mini App.
getSystemInfo	Lấy thông tin về Zalo App và thiết bị.
getDeviceIdAsync	Lấy chuỗi định danh duy nhất của thiết bị.
getContextAsync	Lấy thông tin ngữ cảnh mà Zalo Mini App được mở.

Routing API: Điều hướng trong Zalo Mini App

Routing API giúp nhà phát triển điều hướng giữa các Mini App, trang web và các màn hình khác trong ứng dụng.

API	Mô tả
closeApp	Đóng Zalo Mini App.
openMiniApp	Mở một Zalo Mini App khác.
openWebview	Mở nội dung trong WebView.
sendDataToPreviousMiniApp	Gửi dữ liệu về Mini App được mở trước đó.
getRouteParams	Lấy các tham số được gửi đến trang hiện tại của Mini App.

Storage API: Lưu trữ dữ liệu cục bộ

Storage API giúp Zalo Mini App lưu và quản lý dữ liệu ngay trên thiết bị của người dùng.

API	Mô tả
setItem	Lưu dữ liệu vào bộ đệm theo cơ chế đồng bộ.
getItem	Lấy dữ liệu đã lưu trong bộ đệm.
removeItem	Xóa một dữ liệu đã lưu trong bộ đệm.
clear	Xóa tất cả dữ liệu trong bộ đệm.
getStorageInfo	Lấy thông tin về bộ nhớ lưu trữ hiện tại.

Local File Storage API

Nhóm API này hỗ trợ quản lý file cục bộ trong Zalo Mini App.

API	Mô tả
isSupportLFS	Kiểm tra thiết bị hoặc môi trường có hỗ trợ Local File Storage hay không.
getFileInfo	Lấy thông tin của local file, bao gồm file cache hoặc local data.
getSavedFileList	Lấy danh sách tất cả file cục bộ đã lưu.
removeSavedFile	Xóa file cục bộ đã lưu.
saveFile	Lưu file từ đường dẫn tạm thời vào vùng nhớ cục bộ.

UI API: Tùy chỉnh giao diện Mini App

UI API giúp nhà phát triển điều chỉnh giao diện và trải nghiệm hiển thị của Zalo Mini App.

Feedback API

API	Mô tả
showToast	Hiển thị thông báo nhanh và tự động ẩn sau một khoảng thời gian.
closeLoading	Tắt màn hình Splash Loading.

View API

API	Mô tả
configAppView	Tùy chỉnh trạng thái hiển thị, màu sắc và kiểu hiển thị của status bar, action bar, bottom navigation hoặc safe area.
setNavigationBarColor	Thay đổi màu thanh điều hướng của trang hiện tại.
setNavigationBarLeftButton	Thiết lập nút bên trái trên thanh điều hướng, như Home hoặc Back.
setNavigationBarTitle	Thay đổi tiêu đề trên thanh điều hướng.

Keyboard API

API	Mô tả
hideKeyboard	Ẩn bàn phím trên thiết bị.

Location API

API	Mô tả
getLocation	Lấy vị trí hiện tại của người dùng sau khi được cấp quyền.

Location API thường được sử dụng trong các Mini App hỗ trợ tìm cửa hàng gần nhất, giao hàng, đặt xe, đặt lịch dịch vụ hoặc tìm kiếm theo khu vực.

Media API: Camera, hình ảnh và tài liệu

Media API giúp Zalo Mini App tương tác với camera, thư viện ảnh, video và file trên thiết bị.

Camera API

API	Mô tả
createCameraContext	Tạo đối tượng quản lý camera streaming.
start	Bắt đầu streaming từ camera.
stop	Kết thúc streaming từ camera.
pause	Tạm dừng streaming.
resume	Tiếp tục streaming.
isUsing	Kiểm tra trạng thái camera đang được sử dụng.
updateMediaConstraints	Cập nhật cấu hình streaming.
takePhoto	Chụp ảnh từ camera.
flip	Chuyển đổi giữa camera trước và sau.
setMirror	Bật hoặc tắt chế độ gương cho hình ảnh.
getCameraList	Lấy danh sách camera đang hoạt động trên thiết bị.
getSelectedDeviceId	Lấy device ID của camera đang được chọn.
setDeviceId	Thay đổi camera đang sử dụng bằng device ID.
on	Lắng nghe sự kiện camera.
off	Ngừng lắng nghe sự kiện camera.
checkZaloCameraPermission	Kiểm tra quyền camera trong Zalo.
requestCameraPermission	Yêu cầu bị cấp quyền truy cập camera trên thiết bị.

Media API

API	Mô tả
chooseImage	Chọn hình ảnh từ camera hoặc thư viện.
openMediaPicker	Mở giao diện chọn camera, ảnh, video hoặc file từ thiết bị.
saveImageToGallery	Lưu ảnh vào thư viện media.
saveVideoToGallery	Lưu video vào thư viện media.
downloadFile	Tải file về thiết bị.
openDocument	Mở tài liệu PDF từ đường dẫn URL.

Device API: Tương tác với thiết bị người dùng

Nhóm Device API hỗ trợ Zalo Mini App sử dụng các tiện ích phần cứng cơ bản trên điện thoại.

Network API

API	Mô tả
getNetworkType	Lấy thông tin về loại kết nối mạng hiện tại.
downloadFile	Tải file về thiết bị.

Contact API

API	Mô tả
openPhone	Truy cập ứng dụng gọi điện trên thiết bị.
openSMS	Truy cập ứng dụng nhắn tin SMS trên thiết bị.

Screen API

API	Mô tả
keepScreen	Giữ màn hình luôn bật trong quá trình sử dụng Mini App.

Vibrate API

API	Mô tả
vibrate	Thiết bị được kích hoạt chế độ rung.

Biometric Authentication API

API	Mô tả
openBioAuthentication	Mở giao diện xác thực sinh trắc học.
checkStateBioAuthentication	Kiểm tra trạng thái xác thực sinh trắc học.

Permission API: Quản lý quyền của người dùng

Permission API giúp Mini App yêu cầu hoặc kiểm tra các quyền mà người dùng đã cấp.

API	Mô tả
requestSendNotification	Yêu cầu người dùng cho phép gửi thông báo thông qua OA Mini App.
openPermissionSetting	Mở màn hình cài đặt quyền mà người dùng đã cấp cho ứng dụng.

Zalo API: Tận dụng hệ sinh thái Zalo

Zalo API hỗ trợ Zalo Mini App kết nối trực tiếp với các tính năng quan trọng trong ứng dụng Zalo.

API	Mô tả
openProfile	Mở trang thông tin của người dùng hoặc Official Account.
openProfilePicker	Mở giao diện chọn bạn bè trên Zalo.
openChat	Mở cửa sổ chat với người dùng hoặc Official Account.
followOA	Giao diện yêu cầu người dùng theo dõi Official Account.
unfollowOA	Hủy theo dõi Official Account.
openShareSheet	Mở cửa sổ chia sẻ nội dung trong Zalo.
openPostFeed	Mở giao diện chia sẻ nội dung lên nhật ký Zalo.
createShortcut	Tạo lối tắt của Mini App trên màn hình thiết bị.
viewOAQr	Hiển thị QR Code của trang Official Account.
requestUpdateZalo	Điều hướng người dùng cập nhật Zalo lên phiên bản mới nhất.
minimizeApp	Thu nhỏ Mini App.
favoriteApp	Thêm Mini App vào danh sách yêu thích trong Mini Store.
addRating	Mở cửa sổ đánh giá Mini App.

Advertising API: Hiển thị quảng cáo trong Mini App

Advertising API hỗ trợ nhà phát triển triển khai quảng cáo trong Zalo Mini App.

API	Mô tả
setupAd	Cấu hình thông tin cần thiết để chạy quảng cáo.
loadAd	Tải quảng cáo.
displayAd	Hiển thị quảng cáo sau khi tải thành công.
refreshAd	Xóa quảng cáo trong phiên hiện tại.

Widgets API

Widgets API giúp Zalo Mini App hiển thị các tiện ích tương tác nhanh trên giao diện.

API	Mô tả
showOAWidget	Hiển thị widget Quan tâm OA.
showFunctionButtonWidget	Hiển thị widget Function Button.

Lưu ý khi sử dụng Zalo Mini App API

Khi tích hợp Zalo Mini App API, nhà phát triển nên lưu ý một số điểm sau:

Chỉ sử dụng API thực sự cần thiết cho chức năng của Mini App.
Kiểm tra quyền cần xét duyệt trước khi đưa tính năng vào phiên bản phát hành.
Xin quyền người dùng đúng ngữ cảnh, ví dụ chỉ xin vị trí khi người dùng tìm cửa hàng gần nhất.
Mô tả rõ mục đích sử dụng quyền để tăng sự tin tưởng và tỷ lệ đồng ý.
Kiểm tra kỹ API trên môi trường phát triển trước khi deploy phiên bản Testing hoặc Production.
Ưu tiên xử lý lỗi, trạng thái mạng yếu và các tình huống người dùng từ chối cấp quyền.

Zalo Mini App API là nền tảng quan trọng giúp nhà phát triển xây dựng Mini App có khả năng tương tác sâu với Zalo và thiết bị của người dùng. Từ lấy thông tin người dùng, mở camera, truy cập vị trí đến chia sẻ nội dung, nhắn tin OA hay triển khai quảng cáo, hệ thống API giúp Mini App mở rộng đáng kể khả năng vận hành.

Việc lựa chọn và tích hợp Zalo Mini App API đúng cách sẽ giúp ứng dụng hoạt động ổn định, nâng cao trải nghiệm người dùng và khai thác hiệu quả hệ sinh thái Zalo.

Xem thêm:

Thông tin liên hệ:

Công ty TNHH ABENLA