# js 接口

连接指定设备的蓝牙、下发读/写指令等直接与卡交互的相关方法

# 通用接口

# 连接卡

参数：无
返回结果

参数	数据类型	说明	备注
macAddress	string	MAC地址
deviceAuthId	string	设备Id

示例

// 不需要 MAC地址和设备ID 可不用传参数: simkey.sdk.connect();
simkey.sdk.connect({
   success(res){
      console.log("MAC地址: %o", res.data.macAddress)
      console.log("设备Id: %o", res.data.deviceAuthId)
   },
   fail(res){
      console.log("错误信息: %o", res)
   }
});

1
2
3
4
5
6
7
8
9
10

# 枚举证书

参数:

参数	数据类型	说明	备注
isSign	boolean	证书类型	true: 签名, false: 加密

返回结果:

参数	数据类型	说明	备注
certList	array	证书列表

示例

simkey.sdk.readAllCert({isSign: true}).then(res => {
    console.log("读取证书", res.data.certList)
}).catch(err => {
    console.log("错误信息: %o", err)
})

1
2
3
4
5

# service接口

借助SIMKEY管理平台的能力, 从服务端获取用户证书、U盾列表、验签等快速接口服务

# 验证二维码数据

参数:

参数	数据类型	说明
appId	string	应用ID
platformId	string	平台ID
originalText	string	原文
timestamp	string	时间戳
hashText	string	原文hash
signature	string	签名值

返回结果:
示例

simkey.service.verifyQRCode({
    data: {
        appId: "",
        platformId: "",
        originalText: "",
        timestamp: "",
        hashText: "",
        signature: ""
    },
    success(res) {
        console.log("数据有效", res.data)
    },
    fail(err) {
        console.log("错误信息: %o", err)
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 获取U盾列表

参数:

参数	数据类型	说明
appId	string	应用ID
platformId	string	平台ID
macAddress	string	MAC地址

返回结果:

参数	数据类型	说明	备注
uKeyList	array	U盾列表

示例

simkey.service.getUKeyList({
    data: {
        appId: "",
        platformId: "",
        macAddress: ""
    },
    success(res) {
        console.log("U盾列表: %o", res.data.uKeyList)
        let ukey = res.data.uKeyList[0];
        console.log("U盾: %o", ukey.uKeyId)
        console.log("容器: %o", ukey.containerId)
    },
    fail(err) {
        console.log("错误信息: %o", err)
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 获取用户证书

参数:

参数	数据类型	说明	备注
appId	string	应用ID
platformId	string	平台ID
macAddress	string	MAC地址
isSign	boolean	证书类型	true: 签名, false: 加密

返回结果:

参数	数据类型	说明	备注
certInfo	object	证书

示例

simkey.service.getUserCert({
    data: {
        appId: "",
        platformId: "",
        macAddress: "",
        isSign: true
    },
    success(res) {
        console.log("证书: %o", res.data.certInfo)
    },
    fail(err) {
        console.log("错误信息: %o", err)
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 获取hash值

参数:

参数	数据类型	说明
appId	string	应用ID
platformId	string	平台ID
certInfo	string	证书
hashText	string	原文hash

返回结果:

参数	数据类型	说明
hashText	string	hash值
hashAlgorithm	string	签名算法（MD5、SHA1、SM3、SHA256）
algFlag	string	签名算法标识 1:RSA_1024,2:RSA_2048,3:SM2,4:SM2_V2

示例

simkey.service.getSignHash({
    data: {
        appId: "",
        platformId: "",
        certInfo: "",
        hashText: "",
    },
    success(res) {
        console.log("返回数据: %o", res.data)
        let result = res.data;
        console.log("哈希算法: %o", result.hashAlgorithm)
        console.log("算法标识: %o", result.algFlag)
        console.log("hash值: %o", result.hashText)
    },
    fail(err) {
        console.log("错误信息: %o", err);
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 验签(单签名)

参数:

参数	数据类型	说明	备注
appId	string	应用ID
platformId	string	平台ID
authType	string	签名类型	300: 单签名, 301: 双签名
originalText	string	原文
signCert	string	签名证书
signData	string	签名证书签名得到的签名值
timestamp	string	时间戳
hashText	string	原文hash
signature	string	二维码签名值

返回结果:

参数	数据类型	说明
hashText	string	hash值
hashAlgorithm	string	签名算法（MD5、SHA1、SM3、SHA256）
algFlag	string	签名算法标识 1:RSA_1024,2:RSA_2048,3:SM2,4:SM2_V2

示例

simkey.service.signVerify({
    data: {
        appId: "",
        platformId: "",
        authType: "300", // 单签名
        originalText: "", // 原文
        signCert: "", // 签名证书
        signData: "",  // 签名证书签名得到的签名值
        timestamp: "",
        hashText: "", // 原文hash 值
        signature: "" // 二维码签名值
    },
    success(res) {
        console.log("验签成功: %o", res);
    },
    fail(err) {
        console.log("错误信息: %o", err);
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 验签(双签名)

参数:

参数	数据类型	说明	备注
appId	string	应用ID
platformId	string	平台ID
authType	string	签名类型	300: 单签名, 301: 双签名
originalText	string	原文
signCert	string	签名证书
signData	string	签名证书签名得到的签名值
timestamp	string	时间戳
hashText	string	原文hash
signature	string	二维码签名值
parentHashText	string	文本签名的 hashText，当双签名的时候使用此参数
originalHashImage	string	图片 base64

返回结果:

参数	数据类型	说明
hashText	string	hash值
hashAlgorithm	string	签名算法（MD5、SHA1、SM3、SHA256）
algFlag	string	签名算法标识 1:RSA_1024,2:RSA_2048,3:SM2,4:SM2_V2

示例

simkey.service.signVerify({
    data: {
        appId: "",
        platformId: "",
        authType: "300", // 单签名
        originalText: "", // 原文
        signCert: "", // 签名证书
        signData: "",  // 签名证书签名得到的签名值
        timestamp: "",
        hashText: "", // 原文hash 值
        signature: "", // 二维码签名值
        parentHashText: "", // 文本签名的 hashText，当双签名的时候使用此参数
        originalHashImage: "" // 图片 base64
    },
    success(res) {
        console.log("验签成功: %o", res);
    },
    fail(err) {
        console.log("错误信息: %o", err);
    }
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# 获取平台列表

参数: 无
返回结果:

参数	数据类型	说明	备注
platformList	array	平台列表

示例

simkey.service.getPlatformList({
    success(res) {
        console.log("平台列表:", res.data.platformList);
    },
    fail(err) {
        console.log("错误信息: %o", err);
    }
});

1
2
3
4
5
6
7
8

# 获取应用列表

参数:

参数	数据类型	说明	备注
platformId	string	平台ID

返回结果:

参数	数据类型	说明	备注
appList	array	应用列表

示例

simkey.service.getAppList({
    data: {
        platformId: ''
    },
    success(res) {
        console.log("应用列表:", res.data.appList);
    },
    fail(err) {
        console.log("错误信息: %o", err);
    }
});

1
2
3
4
5
6
7
8
9
10
11

# 获取手机号

参数:

参数	数据类型	说明
appId	string	应用ID
platformId	string	平台ID
macAddress	string	MAC地址

返回结果:

参数	数据类型	说明	备注
phoneNumber	string	手机号

示例

simkey.service.getUserPhoneNumber({
   data: {
      appId: "",
      platformId: "",
      macAddress: ""
   },
   success(res) {
      console.log("phoneNumber", res.data.phoneNumber)
   },
   fail(res) {
      console.log("错误信息: %o", err);
   }
});

1
2
3
4
5
6
7
8
9
10
11
12
13

← 文件模块组件 →