概述
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
},
})