使用说明

所有的JS接口只能在外勤365客户端使用

步骤一:引入JS文件

在需要调用JS接口的页面引入如下JS文件,(支持https):http://res.waiqin365.com/p/open/js/waiqin365.min.js

步骤二:通过config接口注入权限验证配置

所有需要使用JS-SDK的页面必须先注入配置信息,否则将无法调用

wq.config({
  appId: '', // 必填,应用Id
  timestamp: , // 必填,生成签名的时间戳
  nonceStr: '', // 必填,生成签名的随机串
  signature: '',// 必填,签名,见 附录-JS-SDK使用权限签名算法
  jsApiList: [] // 必填,需要使用的JS接口列表,凡是要调用的接口都需要传进来
});

步骤三:通过ready接口处理成功验证

wq.ready(function(){
  // config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中。
});

步骤四:通过error接口处理失败验证

wq.error(function(res){
  // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名。
});

接口调用说明

所有接口通过wq对象来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数:

success:接口调用成功时执行的回调函数。 fail:接口调用失败时执行的回调函数。 complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。 cancel:用户点击取消时的回调函数,仅部分有用户取消操作的api才会用到。

以上几个函数都带有一个参数,类型为对象,其中除了每个接口本身返回的数据之外,还有一个通用属性errMsg,其值格式如下:

1、调用成功时:”xxx:ok” ,其中xxx为调用的接口名

2、用户取消时:”xxx:cancel”,其中xxx为调用的接口名

3、调用失败时:其值为具体错误信息