npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

ynrcc-mobilebank-jssdk

1.1.3 • Public • Published

云南农信手机银行JS-SDK说明文档

本JS-SDK是面向云南农信手机银行客户端网页开发者提供的网页开发工具包。

通过使用JS-SDK,网页开发者可以直接使用分享等手机银行特有的能力,为手机银行用户提供更优质的网页体验。

此文档面向网页开发者介绍JS-SDK如何使用及相关注意事项。

文档

快速上手

依赖

  • 插件支持的手机系统版本:

    !> IOS建议SDK版本 8.0+

    !> Android SDK版本 4.4+

  • 因为项目中使用了Promise来包裹每一个接口,而苹果和安卓(或者说安卓自身各个SDK下的浏览器版本)不同系统的浏览器内核对于Promise的支持并不相同(Promises浏览器兼容一览表),所以大家在使用本SDK前必须要手动检测,并适当开启针对Promise的浏览器polyfill,推荐:

    es6-promise

    promise-polyfill

    • 进行polyfill可能的代码:
    import Promise from 'promise-polyfill';
     
    // To add to window
    if (!window.Promise) {
      window.Promise = Promise;
    }

安装

  • npm:https://www.npmjs.com/package/ynrcc-mobilebank-jssdk
  npm install ynrcc-mobilebank-jssdk

配置

  • 第一种可能的使用方式:直接注入针对浏览器构建的版本ynrcc-mobilebank-jssdk.js使用

    <!-- 1.引入JS文件 **备注:支持使用 AMD/CMD 标准模块加载方法加载**-->
    <script src="./dist/ynrcc-mobilebank-jssdk.js"></script>
     
    <!-- 2.通过config接口注入权限验证配置 -->
    <script type="text/javascript">
      let jsBridge = null
      ynrcc.JSBridge.config({
       debug: true, // 开启调试模式,在PC端开发调试面板中会输出log,如果希望在手机端输出,这里推荐一个插件[Tencent/vConsole](https://github.com/Tencent/vConsole)
       appId: '', // 必填,唯一标识
       timestamp: '', // 必填,生成签名的时间戳
       nonceStr: '',  // 必填,生成签名的随机串
       signature: '', // 必填,签名,见附录1
       url: '', // 当前网页的URL,不包含#及其后面部分
       jsApiList: [], // 必填,需要使用的JS接口列表
       errorHandler(err){
       // 指定和客户端交互过程中抛出的错误的处理函数。应用可以使用该函数来统一处理非业务级别的公共错误消息。
       }
      }).then((bridge) => {
          jsBridge = bridge
      }).catch(err => {
       // 配置错误所抛出的错误,如验签失败等
      })
      // 模拟调用测试:
      jsBridge.closeWindow()
    </script> 
  • 推荐的使用方式:针对es模块系统构建的版本ynrcc-mobilebank-jssdk.mjs使用,以Vue搭建的项目为例

      import Vue from 'vue'
      import App from './App.vue'
      // 1.通过npm安装了sdk之后,通过下面方式引入应用
      import {JSBridge} from 'JSBridge'
      // 2.通过config接口注入权限验证配置
      let jsBridge = null
      JSBridge.config({
       global: window,
       debug: true,
       appId: '',
       timestamp: '',
       nonceStr: '',
       signature: '',
       url: '',
       jsApiList: [],
       errorHandler(err){
       alert(JSON.stringify(err))
       }
      }).then((bridge) => {
       jsBridge = bridge
      }).catch(err => {
       alert(JSON.stringify(err))
      })
     
    new Vue({
      el: '#app',
      render: h => h(App),
      mounted() {
        // 模拟调用测试:
        jsBridge.xxx().then((res)=>{
          // 处理客户端返回的正常结果
        }).catch((err)=>{
          // 处理客户端返回的错误结果
        })
        // 以上的正确和错误都是从业务角度而言
      }
    })

### 接口调用说明

  - 所有接口通过JSBridge.config配置之后返回的对象来调用,参数是一个对象,除了每个接口本身返回的是一个`Promise`对象,通过`then`处理调用成功的情况,通过`catch`处理调用失败的情况,而且是业务层面的【成功】或者【失败】类似:

    ```js
     jsBridge.getUserInfo().then(res => {
       // 获取成功后执行的回调函数
     }).catch(err => {
       // 获取失败(用户未登录等错误)后执行的回调函数
     })
  • then中返回的通用参数列表:(待补充)

    返回的JSON数据包如下:

    {ReturnCode: '000000', ReturnMessage: 'success', OtherField: 'OtherField Content', ...}
    参数 描述
    ReturnCode 000000
    ReturnMessage 接口返回的成功消息如:'分享成功'
  • catch中一般为调用接口出现错误,返回的通用参数列表:(待补充)

    返回的JSON数据包如下:

    {ReturnCode: 'err_code', ReturnMessage: '错误消息', OtherField: 'OtherField Content', ...}
    参数 描述
    ReturnCode 状态码,标识错误的标记,方便查错
    ReturnMessage 接口返回的业务错误如:'用户取消分享'

接口列表

关闭当前网页窗口

jsBridge.closeWindow()

获取当前登录用户信息

jsBridge.getUserInfo().then(res => {
  // 获取成功后执行的回调函数
}).catch(err => {
  // 获取失败(用户未登录等错误)后执行的回调函数
})

返回数据为3DES加密后的数据,秘钥生成规则为:云南农信分配的token拼接上token前24位字符,共56位字符。
例:
   token:12345678123456781234567812345678
 秘钥为:12345678123456781234567812345678123456781234567812345678

参数 描述
UserInfo 用户信息密文

解密后数据如下,默认只返回前3条数据,如需全部数据请联系云南农信相关人员进行配置。

参数 描述
CifNo 客户号,用户唯一标识
CifName 姓名
BranchSeq 开户机构码
UserIdType 证件类型(52:身份证,70:护照)
UserIdNo 证件号码
MobilePhoneEncrypt 手机号

授权登录

jsBridge.oAuthSignIn({needSignIn = false} = {}).then(res => {
  // 授权成功
}).catch(err => {
  // 授权失败
})

参数:

参数 描述
needSignIn 是否需要登录,需要传递true,否则为false

附加返回数据:

参数 描述
SignInState 当前手机银行的登录状态

交互流程:

(流程1:用户先登录手机银行)

(流程2:用户未登录手机银行)

特别注意:

  • 参数中的needSignIn,如果用户已经在客户端已经登录成功,就算这个参数传递的是true,我们也不会拉起登录页面,而是直接同步返回登录状态
  • 调用该接口返回当前手机银行的登录状态为true时,若需要获取当前手机银行的登录用户信息请调用(获取当前登录用户信息)接口

附录1

签名算法

签名生成规则如下:参与签名的字段包括appid(应用id),noncestr(随机字符串),timestamp(时间戳), url(当前网页的URL,不包含#及其后面部分),token(唯一标识) 。对所有待签名参数按照字段名的ASCII 码从小到大排序(字典序)后,使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串string1。这里需要注意的是所有参数名均为小写字符。对string1作sha1加密,字段名和字段值都采用原始值,不进行URL 转义。

即signature=sha1(string1)。 示例:

appid=xxx
noncestr=xxx
timestamp=1414587457
url=https://www.baidu.com?params=value
token=xxx

步骤1. 对所有待签名参数按照字段名的ASCII 码从小到大排序(字典序)后,使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串string1:

appid=xxx&noncestr=xxx&timestamp=1414587457&url=https://www.baidu.com?params=value&token=xxx

步骤2. 对string1进行sha1签名,得到signature:

xxxde62fce790f9a083d5c99e95740ceb90c27ed

注意事项

1.签名用的appid(应用id),token(唯一标识)由云南省农村信用合作社统一分配。

2.签名用的noncestr和timestamp必须与ynrcc.JSBridge.config中的nonceStr和timestamp相同。

3.签名用的url必须是调用JS接口页面的完整URL。

4.出于安全考虑,开发者必须在服务器端实现签名的逻辑。

测试

jssdk前端代码使用mocha完成了mock测试,所有接口都经过自身的集成测试;

> ynrcc-mobilebank-jssdk@1.0.0 test /Users/jiiiiiin/Documents/Atom/ynrcc-mobilebank-jssdk
> mocha
 
 
 
  连通性测试
[ynrcc-jssdk] 混合navigation模块开始
[ynrcc-jssdk] 混合navigation模块完成
    ✓ 测试正常情况
1111 { ReturnCode: '000000' }
 
  连通性测试
[ynrcc-jssdk] 混合navigation模块开始
[ynrcc-jssdk] 混合navigation模块完成
    ✓ 测试业务返回非000000情况
 
  连通性测试
[ynrcc-jssdk] 混合navigation模块开始
[ynrcc-jssdk] 混合navigation模块完成
    ✓ 模拟客户端返回json字符串格式有误的情况
 
 
  3 passing (60ms)

Issues

ynrcc-mobilebank-jssdk 是为云南农信手机银行面向网页开发者提供的基于客户端内的网页开发工具包,如果非合作伙伴请不要开issue。

  • 任何描述不清楚、代码(拜托请别截图)懒得给出的 issue 将会直接 关闭锁定、打上 yet another bad issue 标签;
  • 在 issue 下提无关问题会被直接 删除;

项目文件说明

lib/index.js

这个是项目入口文件。

  • 不建议直接clone源代码进行修改。

test/index_test.js

这个是项目的测试入口文件。

  • sdk所有接口均通过mocha进行模拟测试,因为接口需要运行在手机银行客户端,并依赖其保留的上下文对象,故测试只能做到打桩测试
  • 凡是文档中描述的接口我们都进行过内部测试,如果在某些Android设备上存在问题(因为总所周知Android碎片化比较厉害),那么请提交issue进行详细的bug重现报告

dist/ynrcc-mobilebank-jssdk.js

这是sdk的UMD格式主文件,可以运行在大多数的JavaScript运行环境。

dist/ynrcc-mobilebank-jssdk.mjs

这是sdk的ES格式主文件,如果你的应用使用类似Vue或者React类似技术,那么建议使用该版本。

项目维护者

install

npm i ynrcc-mobilebank-jssdk

Downloadsweekly downloads

2

version

1.1.3

license

MIT

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability