tencent cloud

开放接口

PDF
聚焦模式
字号
最后更新时间: 2026-01-29 00:08:50
小程序 SDK 提供部分开放接口,用于调用和实现登录、获取用户信息、支付等宿主应用提供的能力;当前支持的开放接口如下表格所示:
小程序方法
MiniOpenApiProxy 方法
描述
wx.login
login
登录接口
wx.getUserInfo
getUserInfo
获取用户基本信息
wx.getUserProfile
getUserProfile
获取用户属性信息
wx.getPhoneNumber
getPhoneNumber
获取电话号码
wx.requestPayment
requestPayment
发起支付
wx.checkSession
checkSession
检查登录状态是否过期
wx.requestVirtualPayment
requestVirtualPayment
发起虚拟支付
用户可以通过实现 OpenApiHandler 抽象类,将小程序和宿主应用的数据交互进行关联,如下函数定义:
abstract class OpenApiHandler {
//当小程序调用 wx.requestPayment,请求第三方支付操作时调用
Future<Map<String, dynamic>> requestPayment(
AppInfo appInfo, Map<Object?, Object?> params);

/// 当小程序调用 wx.getUserProfile 请求主机应用程序的用户信息时调用
///
Future<Map<String, dynamic>> getUserProfile(
AppInfo appInfo, Map<Object?, Object?> params);

/// 当小程序调用 wx.login 时调用,请求主机应用程序的登录证书
///
Future<Map<String, dynamic>> login(
AppInfo appInfo, Map<Object?, Object?> params);

/// 当小程序调用 wx.checkSession 时调用,请求主机应用程序的登录状态
/// 检查登录是否已过期
///
Future<Map<String, dynamic>> checkSession(
AppInfo appInfo, Map<Object?, Object?> params);

/// 当小程序调用 wx.getUserInfo 时调用,已被 wx.getUserProfile 过时
/// 兼容早期的小程序 api
///
Future<Map<String, dynamic>> getUserInfo(
AppInfo appInfo, Map<Object?, Object?> params);

/// 当小程序调用 wx.getPhoneNumber 时调用,获取当前用户的电话号码
///
Future<Map<String, dynamic>> getPhoneNumber(
AppInfo appInfo, Map<Object?, Object?> params);
/// 当小程序调用 wx.requestVirtualPayment 时调用,调起虚拟支付功能
Future<Map<String, dynamic>> requestVirtualPayment(
AppInfo appInfo, Map<Object?, Object?> params)
}
获取用户信息示例代码:
@override
Future<Map<String, dynamic>> getUserProfile(
AppInfo appInfo, Map<Object?, Object?> params) async {
print("getUserProfile:$appInfo params:$params");
Map<String, dynamic> result = {
"userInfo": {
"nickName": "xcode",
"avatarUrl":
"https://staticintl.cloudcachetci.com/cms/backend-cms/8WGP653_%E5%BC%80%E5%8F%91%E8%80%85%E5%B7%A5%E5%85%B7%E9%80%9A%E7%94%A8.png",
"gender": 1,
"country": "China",
"province": "ChongQing",
"city": "ChongQing",
}
};
return Future.value(result);
}

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈