API Specifications
TỔNG QUAN
Mini API cung cấp các API để bạn có thể tương tác với MoMo App Platform. Một số API yêu cầu bạn phải được kiểm duyệt trước khi có thể sử dụng.
PHIÊN BẢN HIỆN TẠI
Beta 1.0
CÀI ĐẶT
Để cài đặt được Mini API, vui lòng làm theo hướng dẫn trong mục cấu hình NPM
Mini API được cài tự động khi bạn tạo mới một Mini App. Trong trường hợp bạn muốn cập nhật package này, chạy lệnh bên dưới.
momo-miniapp update-packages
hoặc chạy lệnh bên dưới để cài đặt mới Mini API.
npm install @momo-miniapp/api
TRƯỜNG HỢP SỬ DỤNG
Để import và init API, sử dụng
/** import */
import MiniApi from "@momo-miniapp/api";
/** Call it once, only for Mini App WebView */
MiniApi.init({ appId: "", partnerCode: "" });
Để gọi API, sử dụng
/** call API */
/** open QR code scanner */
MiniApi.scanQRCode((data) => {});
CÁC LỆNH TÍNH NĂNG
User
| Name | Description |
|---|---|
| requestUserConsents | Yêu cầu truy cập thông tin người dùng. Một bottom drawer sẽ xuất hiện để yêu cầu người dùng cung cấp thông tin |
| getUserConsents | Lấy thông tin có được từ requestUserConsents |
| getUserAuth | Lấy thông tin xác thực của người dùng |
Navigation
| Name | Description |
|---|---|
| goHome | Bật màn hình trang chủ |
| goBack | Trở lại màn hình trước đấy |
| openUrl | Mở URL với callback deep link |
| openWeb | Mở web URL |
| dismissAll | Tắt tất cả màn hình |
| dismiss | Tắt màn hình hiện tại và trả lại kết quả cho role trước đó |
Utilities
| Name | Description |
|---|---|
| copyToClipboard | Copy văn bản vào clipboard và hiển thị toast |
| share | Chia sẽ văn bản cho các ứng dụng khác |
Phone
| Name | Description |
|---|---|
| openDialer | Mở ứng dụng gọi điện thoại |
Image
| Name | Description |
|---|---|
| getBase64FromUrl | Chuyển đổi hình ảnh từ dạng URL sang chuỗi base64 |
| getImage | Lấy hình ảnh từ thư viện hoặc chụp một ảnh mới |
| saveImage | Lưu hình ảnh vào thư viện |
| getImageSize | Lấy kích cỡ hình ảnh |
Storage
| Name | Description |
|---|---|
| getItem | Lấy dữ liệu từ nơi lưu trữ |
| setItem | Đặt dữ liệu tại nơi lưu trữ |
| removeItem | Xóa dữ liệu khỏi nơi lưu trữ |
Permissions
| Name | Description |
|---|---|
| requestPermission | Yêu cầu quyền truy cập trên thiết bị như máy ảnh, thư viện... |
| checkPermission | Kiểm tra quyền truy cập đã được chấp nhận |
Location
| Name | Description |
|---|---|
| getLocation | Lấy vị trí của thiết bị |
Camera
| Name | Description |
|---|---|
| scanQRCode | Lấy dữ liệu từ mã QR |
Message, Dialog
| Name | Description |
|---|---|
| showToast | Hiển thị toast |
| hideToast | Ẩn toast |
| showToastSuggestion | Hiển thị Suggestion toast |
| hideToastSuggestion | Ẩn Suggestion toast |
| showAlert | Hiển thị hộp thoại thông điệp |
| showAction | Hiển thị bottom sheet cung cấp chức năng nhanh |
Screen
| Name | Description |
|---|---|
| showLoading | Hiển thị màn hình loading |
| hideLoading | Ẩn màn hình loading |