getUserProfile
获取当前用户信息
H5 可以通过此接口获取运行宿主设备的关键信息，比如屏幕信息，平台信息等。
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| 无 |
未登录 - 返回结果
无
已登录 - 返回结果
{
no: "88888888", // 用户编号
nick_name: "法外狂徒丶张三", // 用户昵称
token: "tokenxxxxx", // 用户授权 Token
thumb_url: "http://x.xxx.cn/xxx.png", // 用户头像地址
im_id: "xxxx", // 网易云信 ID
im_token: "xxxx", // 网易云信 Token
mobile: "13673552648", // 用户登录手机号
money: "0.00", // 用户账户余额
}
getDeviceInfo
获取设备信息
H5 可以通过此接口获取运行宿主设备的关键信息，比如屏幕信息，平台信息等。
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| 无 |
返回结果
{
platform: "iOS", // 平台名称，允许值：Android，iOS，Mini，Web
versionCode: 1, // App 版本号
versionName: "1.0.0", // App 版本名称
device: {
uniqueId: "xxxxx", // 当前设备唯一的标识
},
screen: {
statusBarHeight: 20, // 电池条/状态栏的高度
titleBarHeight: 44, // 标题条的高度
screenWidth: 0, // 手机屏幕的宽度
screenHeight: 0, // 手机屏幕的高度
PPI： 160 // 手机设备像素密度
}
}
finishActivity
销毁当前活动页面
H5 可以直接调用此 API 销毁当前所在页面，客户端 APP 请在页面被销毁之后及时回收系统资源。
接口参数
无
返回结果
无
nativeActivity
打开指定本机 App 页面
H5 页面在宿主机运行时，可能也会根据功能流程跳转至原生 APP 界面，或者想要求本机 APP 在新的活动页面中打开指定链接地址，来保护浏览器历史路径的干净。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| mode | String | 是 | 启动模式：finish，self，keeplive |
| uri | String | 是 | 要跳转的页面 URI 地址路径 |
| meta | Object/Null | 否 | 部分页面在跳转时，可能要求携带参数，此字段为这些页面提供所需要的数据 |
| full | Boolean | 是 | 声明是否全屏（沉浸式）加载指定 H5 页面，此字段仅在 http 页面跳转时有效，并且 self 模式跳转也请忽略此字段 |
关于启动模式 mode 字段的功能实现，详细说明如下：
- finish： 表明客户端在跳转至新的页面时，请直接把当前页面销毁。
- self： 要求客户端在当前浏览器页面打开指定链接
- blank： 要求客户端在新的浏览器页面打开指定链接
关于 meta 字段的属性，会根据所跳转的界面而不同，具体参数请查看 页面跳转 文档。
返回结果
无
getLocalValue
获取本机存储数据
H5 调用此接口可以取得使用 putLocalValue 存入的本地数据，客户端必须保证数据与存入时完全保持一致。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| key | String | 是 | 存入数据时，设置的键 Key |
| default | String | 否 | 指定键 Key 不存在时的默认返回值 |
返回结果
任意存入值
putLocalValue
存储数据到本机
H5 调用此接口可以把任意数据永久存放到本机空间，客户端可以对数据使用任意的格式存储，但必须保证数据不会丢失，且取出时与存入时数据一致。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| key | String | 是 | 存入数据时，设置的键 Key |
| value | String | 是 | 要存入的数据，只能为字符串类型 |
返回结果
true | false
rmLocalValue
移除存储到本机的数据
H5 调用 putLocalValue 存储的数据，可以调用此函数进行清理。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| key | String | 是 | 存入数据时，设置的键 Key |
返回结果
true | false
selectUserAddress
选择用户收货地址
用户在购买商品时，需要选择收货地址，现在收货地址功能是原生APP客户端实现的，需要客户端引导用户选择收货地址，并返回收货地址信息。
接口参数
无
返回结果
{
"id": 2, // 收货地址id
"name": "建委", // 收货人姓名
"mobile": "15639010691", //收货人手机号
"province_code": "410000000000", //省份行政代码
"province_name": "河南省", //省份名称
"province_short": "河南", //省份简称
"city_code": "410100000000", //市份行政代码
"city_name": "郑州市", //市份名称
"city_short": "郑州", //市份简称
"county_code": "410105000000", //区份行政代码
"county_name": "金水区", //区份名称
"county_short": "金水", //区份简称
"address": "asdffffffffffffffffff", //详细地址
"is_default": 0 //是否默认，1=默认，0=非默认
}
appPay
唤起 App 客户端的第三方支付功能
H5 可以使用此接口进行所有场景的支付功能调用，客户端只需要把用户支付成功的返回结果 notify 给 H5 页面即可。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| channel | String | 是 | 要调用的支付渠道 |
| signData | String 或 Object | 是 | H5 已经准备好的支付签名数据，此字段会根据要调用支付渠道的不同而不同 |
- channel =
alipay代表是支付宝支付
signData = 'body=Hello&buyer_email=13788888888&buyer_id=2088002007013600&extra_common_param=你好，这是测试商户的广告。&gmt_create=2014-04-03 20:49:31&gmt_payment=2014-04-03 20:49:50&is_total_fee_adjust=N¬ify_id=70fec0c2730b27528665af4517c27b95¬ify_time=2014-04-03 20:49:52¬ify_type=trade_status_sync&out_trade_no=3618810634349901&price=10.00&quantity=1&seller_email=test@test.com&seller_id=2088002007018916&subject=测试&total_fee=10.00&trade_no=2014040311001004370000361525&trade_status=TRADE_FINISHED&use_coupon=N'
- channel =
wechat代表是微信支付
signData = {
appid: 'wx8888888888888888',
partnerid: '1900000109',
prepayid: 'WX1217752501201407033233368018',
package: 'Sign=WXPay',
noncestr: '5K8264ILTKCH16CQ2502SI8ZNMTM67VS',
timestamp: '1412000000',
sign: 'C380BEC2BFD727A4B6845133519F3AD6'
}
返回结果
{
status: 'success | error', // 成功返回 success 字符串，失败返回 error 字符串
message: '这里是支付错误的时候，返回的提示信息'
}
scanQRCode
调用扫描二维码功能
在部分页面场景可能需要 H5 使用扫描二维码功能，可以调用此功能接口来获取二维码的扫描结果。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| type | String | 是 | 要扫描的码类型 |
- type =
qr-code代表要扫描的二维码类型 - type =
bar-code代表要扫描的是条形码类型
返回结果
直接返回扫码数据
oauth2
唤起第三方应用授权
用户绑定支付宝和绑定微信账号时，可以使用 OAuth2 协议唤起第三方应用进行用户授权，以便 H5 获取授权后的信息。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| app | String | 是 | 要进行 OAuth2 授权的 APP 名称 |
-
alipay= 支付宝授权 -
wechat= 微信授权
返回原始授权数据
{
key: value,
...
}
mustLoginDlg
显示用户还未登录，提醒登录的弹窗
H5 页面上弹出的弹窗，在个别界是无法使用的，需要客户端提供此弹窗接口限制用户操作。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| message | String | 是 | 提醒文案 |
| title | String | 是 | 弹窗标题 |
返回结果
true | false
- true = 用户去登录了，与登录结果无关
- false = 用户没有去登录，与登录结果无关
selectPicture
让用户选择一张图片
H5 使用选择图片功能在安卓上有兼容性问题，所以实现此 API 用来让 H5 调用原生的图片选择。
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| min | Integer | 是 | 指定图片压缩到此阈值以内，单位：kb，对所有场景有效 |
| scene | string | 是 | 用户选择图片的场景，客户端来根据场景显示定制页面 |
| meta | Object | 否 | 在不同场景中选择图片时，此字段从来给场景传递的额外的参数 |
scene = default
默认使用的图片选择场景，单选，不裁剪，直接返回。scene = homepage
个人主页使用的图片上传场景，多选（≤9张），不裁剪，直接上传至阿里云服务器，并返回阿里云链接。
{
max: 9 // 代表最多允许上传9张图片
}
popFindAlter
发现界面调用原生弹窗
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| btns | Array | 是 | 弹窗的列表展示信息 |
Params 参数样例数据
{
"btns": [
{"title": "收藏", "id": "1"},
{"title": "举报", "id": "2"},
]
}
返回结果
Base64 编码的 JSON 对象
{
"id":1234 //// 以上操作的相应条目的id
}
goToThreeApp
点击第三方app按钮的事件
接口参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| appId | String | 是 | 点击的第三方app的id |
参数说明
1是微博；2是知乎；3是抖音；4是快手；5是微视；6是哔哩哔哩
返回结果
nil