[
]
ZhouSa.com-宙飒天下网 概述
cmbc-miniapp-jssdk是面向民生手机银行小程序开发者提供的网页开发工具包。
接口调用说明
cmbc-miniapp-jssdk默认导出cmbc实例,所有的接口通过该实例对象来调用。
安装
# --registry 为 npm 私有仓库的地址 $ npm install cmbc-miniapp-jssdk --registry=http://xxx.x.x.x
import cmbc from 'cmbc-miniapp-jssdk'
cmbc-miniapp-jssdk接口定义
canIUse()
判断小程序的API是否在当前版本可用。
参数 string
使用 ${API} 方式来调用
返回值 boolean
当前版本是否可用
示例代码:
const boolean = cmbc.canIUse('request') console.log(boolean)
请求:request()
客户端发起一个 HTTPS请求
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | string | 是 | 开发者服务器接口地址 | |
data | string/object | 否 | 请求的参数 | |
method | string | POST | 否 | HTTP 请求方法 |
dataType | string | json | 否 | 返回的数据格式 |
responseType | string | text | 否 | 响应的数据类型 |
encrypted | boolean/string | false | 否 | 是否加密 |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
method 参数的合法值
值 | 说明 |
---|---|
GET | HTTP 请求 GET |
POST | HTTP 请求 POST |
dataType 参数的合法值
值 | 说明 |
---|---|
json | 返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse |
其他 | 不对返回的内容进行 JSON.parse |
responseType 参数的合法值
值 | 说明 |
---|---|
text | 响应的数据为文本 |
encrypted 参数的合法值
值 | 说明 |
---|---|
false或者空 | 不加密 |
true | 加密,登录后交易使用的加密 |
005 | 加密,登录前交易使用的加密 |
success 回调参数:
属性 | 类型 | 说明 |
---|---|---|
data | string/Object/Arraybuffer | 开发者服务器返回的数据 |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
header | Object | 开发者服务器返回的 HTTP Response Header |
fail 回调参数:
属性 | 类型 | 说明 |
---|---|---|
error | Object | 开发者服务器返回的错误信息 |
示例代码:
import cmbc from 'cmbc-miniapp-jssdk' cmbc.request({ url: 'test.php', // 仅为示例,并非真实的接口地址 data: { x: '', y: '' }, success(res) { const { data, statusCode } = res console.log(data) }, fail(res) { const { error } = res console.log(error) } })
设置导航栏标题:setNavigationBarTitle()
动态设置当前页面的标题
参数:
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
title | string | 否 | 标题 | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
回调参数:无
示例代码:
cmbc.setNavigationBarTitle({ title: '当前页面' })
关闭本页面:navigationCloseThisPage()
关闭当前网页窗口
参数
无
回调参数:无
示例代码:
cmbc.navigationCloseThisPage()
调用接口获取登陆凭证: login()
调用接口获取登录凭证(code)。通过凭证进而换取用户登录态信息,包括用户的唯一标识(openid)及本次登录的会话密钥(session_key)等。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 回调参数:
属性 | 类型 | 说明 |
---|---|---|
code | string | 用户登录凭证 |
示例代码:
cmbc.login({ success: (res) => { // 成功后的回调 const { code } = res }, })
获取当前的地理位置: getLocation()
获取当前的地理位置
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 回调参数:
属性 | 类型 | 说明 |
---|---|---|
latitude | number | 纬度,范围为 -90~90,负数表示南纬 |
longitude | number | 经度,范围为 -180~180,负数表示西经 |
示例代码:
cmbc.getLocation({ success: (res) => { // 成功后的回调 const { latitude, longitude } = res }, })
还没有评论,来说两句吧...