《健康信息可信访问终端SDK接口定义.docx》由会员分享,可在线阅读,更多相关《健康信息可信访问终端SDK接口定义.docx(4页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、附录A SDK接口定义A.1可信终端设备注册A. 1.1接口描述可信终端调用该接口进行设备注册。该方法仅在设备厂商苜次使用可信访问SDK时调用。请求参数表A.1可信终端设备注册请求参数参数名称类型必选参数说明deviceCorpstring是设备厂商的统一社会信用代码deviccTypestring是设备类型,建议取值范围闸机联动;壁挂终端:落地终端:手持终端:台式终端deviceModelstring介设备型号,设备厂商自定义deviceNostring是设备序列号,设备厂商自定义macAddressstring是设备MAC地址licensestring是设备许可,由可信访问服务平台分配us
2、erstring是设备使用单位,实际购买使用可信终端的单位A. 1.3响应参数表A. 2可信设备注册响应参数参数名称类型必选参数说明codeint是返回码,。表示成功msgstring是返回消息。多用于描述失败时的错误信息datastring是设备注册号,由平台生成设备全局唯一标识符A.2 SDK健康检测A. 2.1接口描述检测可信访问SDK健康状态。该方法用于可信设备每次启动时的自检场景。请求参数无。响应参数表A. 3 SDK健康检测响应参数参数名称类型必选参数说明codeint是返回码,0表示成功msgstring是返回消息。多用于描述失败时的错误信息A.3申领可信访问令牌A. 3.1接口
3、描述用户在可信设备上进行身份认证后,设备方可调用该接口申领可信访问令牌。A. 3. 2请求参数表A.4申领可信访问令牌请求参数参数名称类型必选参数说明transaction!dstring是业务流水号authTypestring是认证方式,取值范围为1:刷脸;2:读卡;3:扫码namestring否姓名,认证方式为1或2时该项必填idTypestringr.证件类型,取值范围为1:身份证,认证方式为1或2时该 项必填idNostring证件号码,SDK会使用平台证书加密该字段,认证方式为1或2时该项必填qrCodestring否二维码码值,认证方式为3时该项必填locationstring否设
4、备场所位置permissionstringr.访问授权信息A. 3. 3响应参数表A. 5申领可信访问令牌响应参数参数名称类型必选参数说明codeint是返回码,0表示成功msgstring是返回消息。多用于描述失败时的错误信息datastring是可信访问令牌A.4数字签名A. 4.1接口描述使用设备私钥进行数字签名的密码服务接口。该方法用于可信终端访问健康信息数据资源服务时的请求签名鉴权。A. 4. 2请求参数表A.6数字签名请求参数参数名称类型必选参数说明plainTextstring是明文(待签名字符串)signAlgint是签名算法,取值范围1: SM3WithSM2)A. 4. 3
5、响应参数表A.7数字签名响应参数参数名称类型必选参数说明codeint是返回码,0表示成功msgstring是返回消息。多用于描述失败时的错误信息datastring是签名值A.5获取证书序列号A. 5.1接口描述获取当前有效设备证书的证书序列号。A. 5. 2请求参数无。A. 5. 3响应参数表A. 8获取证书序列号响应参数参数名称类型必选参数说明codeint是返回码,。表示成功msgstring是返回消息。多用于描述失败时的错误信息datastring是设备证书序列号A.6数字信封解密A. 6.1接口描述使用设备私钥对数据信封加密后的密文进行解密。该方法用于可信终端解密数字信封加密后的健康信息。A. 6. 2请求参数表A. 9数字信封解密请求参数参数名称类型必选参数说明cipherTexlstring是数字信封密文encAlgint,上签名算法,取值范围1: SM4WithSM2. 2: SMlWithSM2)A. 6. 3响应参数表A.10数字签名响应参数参数名称类型必选参数说明codeint是返回码,。表示成功msgstring是返回消息。多用于描述失败时的错误信息datastring是解密后的原文
限制150内