概述

cmbc-miniapp-jssdk是(shì)面向民生手機銀行小程序開發者提供的(de)網頁開發工具包。

接口調用說(shuō)明

cmbc-miniapp-jssdk默認導出(chū)cmbc實例,所有的(de)接口通過該實例對象來(lái)調用。

安裝

# --registry 爲(wéi / wèi) npm 私有倉庫的(de)地(dì / de)址
$ npm install cmbc-miniapp-jssdk --registry=http://xxx.x.x.x
import cmbc from 'cmbc-miniapp-jssdk'


cmbc-miniapp-jssdk接口定義

canIUse()

判斷小程序的(de)API是(shì)否在(zài)當前版本可用。

參數 string

使用 ${API} 方式來(lái)調用

返回值 boolean

當前版本是(shì)否可用

示例代碼:

const boolean = cmbc.canIUse('request')

console.log(boolean)

請求:request()

客戶端發起一(yī / yì /yí)個(gè) HTTPS請求

參數

屬性 類型 默認值 必填 說(shuō)明
url string 是(shì) 開發者服務器接口地(dì / de)址
data string/object 請求的(de)參數
method string POST HTTP 請求方法
dataType string json 返回的(de)數據格式
responseType string text 響應的(de)數據類型
encrypted boolean/string false 是(shì)否加密
success function 接口調用成功的(de)回調函數
fail function 接口調用失敗的(de)回調函數
complete function 接口調用結束的(de)回調函數(調用成功、失敗都會執行)

method 參數的(de)合法值

說(shuō)明
GET HTTP 請求 GET
POST HTTP 請求 POST

dataType 參數的(de)合法值

說(shuō)明
json 返回的(de)數據爲(wéi / wèi) JSON,返回後會對返回的(de)數據進行一(yī / yì /yí)次 JSON.parse
其他(tā) 不(bù)對返回的(de)内容進行 JSON.parse

responseType 參數的(de)合法值

說(shuō)明
text 響應的(de)數據爲(wéi / wèi)文本

encrypted 參數的(de)合法值

說(shuō)明
false或者空 不(bù)加密
true 加密,登錄後交易使用的(de)加密
005 加密,登錄前交易使用的(de)加密

success 回調參數:

屬性 類型 說(shuō)明
data string/Object/Arraybuffer 開發者服務器返回的(de)數據
statusCode number 開發者服務器返回的(de) HTTP 狀态碼
header Object 開發者服務器返回的(de) HTTP Response Header

fail 回調參數:

屬性 類型 說(shuō)明
error Object 開發者服務器返回的(de)錯誤信息

示例代碼:


import cmbc from 'cmbc-miniapp-jssdk'

cmbc.request({
  url: 'test.php', // 僅爲(wéi / wèi)示例,并非真實的(de)接口地(dì / de)址
  data: {
    x: '',
    y: ''
  },
  success(res) {
    const { data, statusCode } = res
    console.log(data)
  },
  fail(res) {
    const { error } = res
    console.log(error)
  }
})

設置導航欄标題:setNavigationBarTitle()

動态設置當前頁面的(de)标題

參數:

屬性 類型 默認值 必填 說(shuō)明
title string 标題
success function 接口調用成功的(de)回調函數
fail function 接口調用失敗的(de)回調函數

回調參數:無

示例代碼:


cmbc.setNavigationBarTitle({
  title: '當前頁面'
})

關閉本頁面:navigationCloseThisPage()

關閉當前網頁窗口

參數

回調參數:無

示例代碼:

cmbc.navigationCloseThisPage()

調用接口獲取登陸憑證: login()

調用接口獲取登錄憑證(code)。通過憑證進而(ér)換取用戶登錄态信息,包括用戶的(de)唯一(yī / yì /yí)标識(openid)及本次登錄的(de)會話密鑰(session_key)等。

參數

屬性 類型 默認值 必填 說(shuō)明
success function 接口調用成功的(de)回調函數
fail function 接口調用失敗的(de)回調函數
complete function 接口調用結束的(de)回調函數(調用成功、失敗都會執行)

success 回調參數:

屬性 類型 說(shuō)明
code string 用戶登錄憑證

示例代碼:

cmbc.login({
    success: (res) => {
        // 成功後的(de)回調
        const { code } = res
    },
})

獲取當前的(de)地(dì / de)理位置: getLocation()

獲取當前的(de)地(dì / de)理位置

參數

屬性 類型 默認值 必填 說(shuō)明
success function 接口調用成功的(de)回調函數
fail function 接口調用失敗的(de)回調函數
complete function 接口調用結束的(de)回調函數(調用成功、失敗都會執行)

success 回調參數:

屬性 類型 說(shuō)明
latitude number 緯度,範围爲(wéi / wèi) -90~90,負數表示南緯
longitude number 經度,範围爲(wéi / wèi) -180~180,負數表示西經

示例代碼:

cmbc.getLocation({
    success: (res) => {
        // 成功後的(de)回調
        const { latitude, longitude } = res
    },
})
Copyright © 屯昌單支科技有限公司 2019 all right reserved,powered by Gitbook聯系方式: wanglihang@mskj.com
修訂時(shí)間: 2019-08-02 16:19:34

results matching ""

    No results matching ""