maketionCardReader

来自于：脉可寻立即使用

auth isAuth clearAuth open getDataWithUuid getDataWithTime uploadImg getCardImg

概述

maketionCardReader模块封装了脉可寻名片识别的sdk，可通过摄像头扫描名片读取名片信息。

不能同时添加的模块：baiduNavigation

在集成此模块之前可先配置config文件，也可不配置config文件直接从前端js将apiKey和apiSecret传入模块原生代码。在config里添加如下字段：

  • 名称：maketionCardReader
  • 参数：apiKey、apiSecret
  • 描述：apiKey即是从脉可寻云名片识别服务器申请获得的appkey，apiSecret即是从脉可寻云名片识别服务器申请获得的secure

配置示例：

  1. <feature name="maketionCardReader">
  2.                     <param name="apiKey" value=" AD1B0E942E0D7240CCFD355A28476E7E" />
  3.                     <param name="apiSecret" value="b2235093fac07c7bb4fdace94ca97007cd336ba8fccbcdf3e8e575e60e28d23e5fb3d972a203fd7e4553380a1233f6ff96e034650228c557cf6313de7c3ee9f7" />
  4. </feature>

字段描述：

1、apiKey：申请获得的appKey

2、apiSecret：申请获得的secure

auth

授权

auth({params}, callback(ret, err))

params

uid：

  • 类型：字符串
  • 默认值：12345
  • 描述：合作伙伴客户标识，可为空

apiKey：

  • 类型：字符串
  • 默认值：无
  • 描述：从脉可寻名片识别服务器申请获得，可为空，若为空则从config.xml读取

apiSecret：

  • 类型：字符串
  • 默认值：无
  • 描述：从脉可寻名片识别服务器申请获得，可为空，若为空则从config.xml读取

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status: //授权成功状态值
  3.     uid：  //统用户标识(获取数据可根据此标识来获取)
  4. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg: //错误描述
  3.     code：//错误码
  4. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.auth({
  3.     uid: 123456
  4. }, function(ret, err) {
  5.     if (ret.status) {
  6.         api.alert({
  7.             title: "提示",
  8.             msg: ret.uid
  9.         });
  10.     } else {
  11.         api.alert({
  12.             title: "出错了",
  13.             msg: err.msg
  14.         });
  15.     }
  16. });

补充说明

授权用户

可用性

iOS系统

可提供的1.0.0及更高版本

isAuth

判断是否授权验证通过

isAuth(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //是否授权验证成功
  3. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.isAuth(function(ret, err) {
  3.     if (ret.status) {
  4.         api.alert({
  5.             title: "提示",
  6.             msg: "验证成功"
  7.         });
  8.     }
  9. });

补充说明

判断是否授权

可用性

iOS系统

可提供的1.0.0及更高版本

clearAuth

清除验证信息

clearAuth(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //是否清除成功
  3. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.clearAuth(function(ret, err) {
  3.     if (ret.status) {
  4.         api.alert({
  5.             title: "提示",
  6.             msg: "清除验证成功"
  7.         });
  8.     }
  9. });

补充说明

清除验证信息

可用性

iOS系统

可提供的1.0.0及更高版本

open

拍照并上传脉可寻云识别服务器

open(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     state：  //上传图片状态值，字符串类型，取值范围：
  3.     uploading：开始上传
  4.     uploaded：上传完成
  5.     err：    上传错误
  6.     uuid：         //图片标识，上传完成后可以根据UUID获取数据
  7. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg:       //错误描述
  3. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.open(function(ret, err) {
  3.     api.alert({
  4.         title: "提示",
  5.         msg: ret.state + '*' + ret.uuid
  6.     });
  7. });

补充说明

打开摄像头拍照并上传

可用性

iOS系统

可提供的1.0.0及更高版本

getDataWithUuid

根据uuid获取数据

getDataWithUuid({params}, callback(ret, err))

params

uuids：

  • 类型：数组对象
  • 默认值：无
  • 描述：拍照上传后获取的标识组成的数组，不可为空

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //获取数据成功状态值
  3.     datas：          //用户名片数据组成的数组
  4. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg:       //错误描述
  3.     code：       //错误码
  4. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.getDataWithUuid({
  3.     uuids: ['987654']
  4. }, function(ret, err) {
  5.     if (ret.status) {
  6.         api.alert({
  7.             title: "提示",
  8.             msg: ret.datas
  9.         });
  10.     } else {
  11.         api.alert({
  12.             title: "出错了",
  13.             msg: err.msg
  14.         });
  15.     }
  16. });

补充说明

无

可用性

iOS系统

可提供的1.0.0及更高版本

getDataWithTime

根据时间获取数据

getDataWithTime({params}, callback(ret, err))

params

time：

  • 类型：字符串
  • 默认值：0
  • 描述：为时间戳，当前时间距1970年秒数，可为空，若0表示全部数据

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status:       //获取数据成功状态值
  3.     datas：          //用户名片数据组成的数组
  4. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg:       //错误描述
  3.     code：//错误码
  4. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.getDataWithTime({
  3.     time: 187656
  4. }, function(ret, err) {
  5.     if (ret.status) {
  6.         api.alert({
  7.             title: "提示",
  8.             msg: ret.datas
  9.         });
  10.     } else {
  11.         api.alert({
  12.             title: "出错了",
  13.             msg: err.msg
  14.         });
  15.     }
  16. });

补充说明

无

可用性

iOS系统

可提供的1.0.0及更高版本

uploadImg

用户图片上传错误，重新上传

uploadImg(params,callback(ret, err))

params

uuid：

  • 类型：字符串
  • 默认值：无
  • 描述：图片标识，上次上传过程事件返回，不可为空

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     state：  //上传图片状态值，字符串类型，取值范围：
  3.     uploading：开始上传
  4.     uploaded：上传完成
  5.     err：    上传错误
  6.     uuid：         //图片标识，上传完成后可以根据UUID获取数据
  7. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg:       //错误描述
  3. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.uploadImg(function(ret, err) {
  3.     api.alert({
  4.         title: "提示",
  5.         msg: ret.state + '*' + ret.uuid
  6.     });
  7. });

补充说明

无

可用性

iOS系统

可提供的1.0.0及更高版本

getCardImg

获取名片原图

getCardImg(params,callback(ret, err))

params

uuid：

  • 类型：字符串
  • 默认值：无
  • 描述：图片上传过程事件返回或获取名片数据中，不可为空

save：

  • 类型：JSON 对象
  • 默认值：见内部字段
  • 描述：获取的图片保存位置，可为空

内部字段：

  1. {
  2.     album:            //布尔值，是否保存到系统相册，默认false，可为空
  3.     imgPath:          //保存的文件路径,字符串类型，无默认值,可为空,空则不保存若路径不存在文件夹则创建此目录
  4.     imgName:         //保存的图片名字，字符串类型，无默认值,可为空,空则不保存支持png和jpg格式，若不指定格式，则默认png
  5. }

callback(ret, err)

ret：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     status：  //获取图片状态值
  3. }

err：

  • 类型：JSON 对象

内部字段：

  1. {
  2.     msg:       //错误描述
  3. }

示例代码

  1. var maketionCardReader = api.require('maketionCardReader');
  2. maketionCardReader.getCardImg({
  3.     uuid: "989898",
  4.     save: "fs://test.png"
  5. }, function(ret, err) {
  6.     api.alert({
  7.         title: "提示",
  8.         msg: ret.status
  9.     });
  10. });

补充说明

无

可用性

iOS系统

可提供的1.0.0及更高版本