信步云业务端api接口文档
1. 访问地址
1.1 测试地址
https: //api-sit.isignet.cn:8082/
https: //api-sit.isignet.cn:8082/ids/v1/outer/(业务接口地址)
1.2 正式地址
https: //api.isignet.cn/(业务接口地址)
2. 请求报文格式说明
2.1 报文格式
接口形式:HTTP服务resfulAPI的形式
报文编码格式为UTF-8
请求方式:POST
POST请求头格式为Content-Type: application/json
2.2 公共参数
2.2.1 公共请求参数
字段名 | 字段内容 | 字段类型 | 是否必填 |
---|---|---|---|
version | 版本,默认为1.0 | String | 是 |
signAlgo | 签名算法,目前只支持HMAC和HmacSHA256 | String | 是 |
deviceId | 由BJCA分配的设备ID | String | 是 |
appId | 由BJCA分配的应用ID | String | 是 |
transId | 业务调用方随机生成的唯一标识,支持最大64位,业务流水号 | String | 否 |
signature | 签名值。对请求报文进行签名计算得到,计算方法参考3章节 | String | 是 |
2.2.2 公共响应参数
字段名称 | 字段内容 | 字段类型 | 是否必须 |
---|---|---|---|
status | 响应码,200即为成功 | String | 是 |
message | 响应信息 | String | 是 |
transId | 业务流水号 | String | 是 |
data | 响应内容 | String | 否 |
3. 报文签名值signature计算方法
3.1 签名值signature生成的通用步骤
第一步,设所有发送或者接收到的数据为集合M,将集合M内非空参数值的参数按照参数名ASCII码从小到大排序(字典序),使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串stringA。
特别注意以下重要规则:
◆ 参数名ASCII码从小到大排序(字典序);
◆ 如果参数的值为空,则不参与签名,且请求报文中也不要带此参数;
◆ 参数名区分大小写;
第二步,对stringA对进行HMAC运算,得到hmac的值后再做Base64编码,最后得到sign值signature。
String signTemp = hmac(stringA, secret); //secret由BJCA分配
String signature = Base64(signTemp);
3.2 报文请求及响应示例
接口请求响应示例:
以调用添加签名任务接口为例(公共参数标记红色,业务参数标记蓝色),请求报文如下:
{ |
其中:
对示例请求的参数按照key=value的格式,并按照参数名ASCII字典序排序后字符串如下:
stringA=appId=APP_52E0099A69414266B84DFAB4999E1299&data=Q29zcyBTaWduIERhdGEgRm9yIFRlc3Qu &signAlgo=HMAC&transId=20190531001&version=1.0
计算签名值signature:
String signTemp = hmac(stringA, secret); //对字符串用secret进行HMAC加密
String signature = Base64(signTemp); //加密后结果进行Base64
对上述待签名原文进行HMAC-SHA256签名的签名值结果如下:wyLPhb2JwrcT6WPMDxa/61BMKdSVZc5gpaU21n/bfgA=
待发送报文如下:
{"version":"1.0","appId":"APP_52E0099A69414266B84DFAB4999E1299","signAlgo":"HMAC","transId":"20190531001","title":"测试长签名","description":"签名任务描述","dataType":"DATA","algo":"SM3withSM2","data":"Q29zcyBTaWduIERhdGEgRm9yIFRlc3Qu","signature":"P2yQKZuDdFFoatgBXlMSsBttnczNuDAGWyTSu/U4pwM="} |
响应报文如下:
{ |
4. 接口描述
4.1 用户及设备管理
添加信任用户
MSSPServer/biz/user/v1/addTrustedUser
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
name | String | 用户名 | 是 |
idType | String | 用户证件类:SF-身份证;HZ-护照 | 是 |
idNum | String | 证件号 | 是 |
mobile | String | 手机号 | 是 |
channelId | String | 证书渠道编号 | 否 |
rdns | String | 自定义的用户主题项(如 “o=65a8585dc5e042c083ced65f33e344e6”) | 否 |
extMap | String | 扩展项内容 HashMap<String,String> 2 JSON格式。如果想把身份证号签在证书里,可以传”extMap”:{“2.16.840.1.113732.2”:”身份证号”} | 否 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
msspId | 用户编号 | String | 是 |
authCode | 授权码 | String | 是 |
qrCode | 二维码信息 | String | 是 |
expirationTime | 过期时间 | String | 是 |
查询用户信息
MSSPServer/biz/user/v1/queryUserInfo
业务请求参数
通过msspId 或者证件类型证件号查询用户信息
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 否 |
idType | String | 证件类型 | 否 |
idNum | String | 证件号 | 否 |
注:查询时有两种查询方式:
方式一:单独以用户编号为条件进行查询,当传入用户编号不为空时使用这种方式进行查询;
方式二:以证件类型和证件号作为条件进行查询,这种情况下必须同时传入证件类型和证件号;
业务响应参数
字段名称 | 字段描述 | 类型 |
---|---|---|
msspId | 用户编号 | String |
mobile | 手机号 | String |
name | 姓名 | String |
userStatus | 用户状态 | String |
sealImg | 印章图片(Base64格式) | String |
注: 用户状态含义:
NOT_EXIST:用户信息不存在或已注销
LOCKED:用户被冻结
ACTIVE:用户已经激活
NOT_ACTIVE:用户尚未激活
修改手机号
MSSPServer/biz/user/v1/changeMobile
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 是 |
mobile | String | 手机号 | 是 |
业务响应参数
判断接口调用成功即表示修改成功
冻结用户
MSSPServer/biz/user/v1/lockUser
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 是 |
userStatus | String | 用户新状态(ACTIVE:解冻,LOCKED:冻结) | 是 |
业务响应参数
判断接口调用成功即表示修改成功
注销用户
MSSPServer/biz/user/v1/deleteUser
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 是 |
业务响应参数
判断接口调用成功即表示修改成功
4.2 常用协同签名接口
网页签章添加任务
MSSPServer/biz/signjob/v1/addSignWebPage
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 否 |
plain | String | 签名原文BASE64 | 是 |
jobSignAlgo | String | 签名算法(SHA1withRSA SHA256withRSA SM3withSM2) | 是 |
expiryDate | String | 有效期:单位分钟,默认三天 | 否 |
description | String | 描述 | 否 |
业务响应参数
字段名称 | 字段描述 | 类型 |
---|---|---|
signJobId | 签名任务ID | String |
qrCode | 二维码信息 | String |
网页签章获取结果
MSSPServer/biz/signjob/v1/querySignWebPage
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
signJobId | String | 网页签章任务ID | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 |
---|---|---|
signStatus | 任务状态 | String |
signResult | 网页签章结果base64编码 | String |
任务状态含义说明:
WAITING_USER_SIGN:任务尚未签署
USER_SIGN_FINISH:任务签署完成,完成状态才能获取到签名结果
TIMEOUT:任务超期,已经无法签署
网页签章验签
MSSPServer/biz/verify/v1/verifySignEss
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
plain | String | 原文的base64 | 是 |
signResult | String | 3.2.2.网页签章获取结果的响应参数:网页签章结果,无须base64 | 是 |
dataSignAlgo | String | 签名算法(SHA1withRSA SHA256withRSA SM3withSM2) | 是 |
业务响应参数
接口调用成功即表示验证成功;否则返回错误码及错误信息。
添加认证任务
MSSPServer/biz/signjob/v1/addAuthJob
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
jobSignAlgo | String | 签名算法 | 是 |
description | String | 描述 | 否 |
msspId | String | 用户编号,发起任务时无法确定签名者,此项可以为空 | 否 |
expiryDate | String | 有效期:单位分钟,默认一小时 | 否 |
业务响应参数
字段名称 | 字段描述 | 类型 |
---|---|---|
signJobId | 签名任务ID | String |
signData | 待签数据(Base64格式) | String |
qrCode | 二维码信息 | String |
说明:认证任务由信步云服务产生随即因子作为待签数据。
认证任务获取结果
MSSPServer/biz/signjob/v1/queryAuthJob
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
signJobId | String | 签名任务ID | 是 |
业务响应参数
名称 | 类型 | 描述 |
---|---|---|
signStatus | String | 任务状态 |
signCert | String | 签名证书 |
signData | String | 签名原文的base64 |
signResult | String | 签名值 |
msspId | String | 进行签名的用户编号 |
任务状态含义说明:
WAITING_USER_SIGN:任务尚未签署
USER_SIGN_FINISH:任务签署完成,完成状态才能获取到签名结果
TIMEOUT:任务超期,已经无法签署
添加批量数据签名任务
MSSPServer/biz/signjob/v1/addSignJobBatch
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
dataType | String | 原文类型(HASH:哈希数据,PLAIN:原文数据) | 是 |
jobSignAlgo | String | 签名算法 | 是 |
description | String | 描述 | 否 |
msspId | String | 用户编号,发起任务时无法确定签名者,此项可以为空 | 否 |
expiryDate | String | 有效期:单位分钟,默认三天 | 否 |
signDataList | String | 数据列表,内容是由List |
是 |
SignDataBean | SignDataBean | 数据对象,参数如下 | 是 |
data | String | 待签数据(Base64格式) | 是 |
fileUniqueId | String | 数据编号 | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 |
---|---|---|
signJobId | 签名任务ID | String |
qrCode | 二维码信息 | String |
批量签名获取结果
MSSPServer/biz/signjob/v1/querySignJobBatch
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
signJobId | String | 签名任务ID | 是 |
业务响应参数
名称 | 类型 | 描述 |
---|---|---|
signStatus | String | 任务状态 |
signCert | String | 签名证书 |
signResultList | List |
签名结果列表 |
SignDataResult | 数据对象 | 签名结果对象 |
signData | String | 签名原文的base64 |
signResult | String | 签名值 |
fileUniqueId | String | 数据编号 |
任务状态含义说明:
WAITING_USER_SIGN:任务尚未签署
USER_SIGN_FINISH:任务签署完成,完成状态才能获取到签名结果
TIMEOUT:任务超期,已经无法签署
数据签名验签
MSSPServer/biz/verify/v1/verifySign
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
dataSignAlgo | String | 签名算法(SHA1withRSA SHA256withRSA SM3withSM2) | 是 |
plain | String | 原文的base64 | 是 |
signResult | String | 签名结果的 base64 | 是 |
cert | String | 证书 | 是 |
业务响应参数
接口调用成功即表示验证成功;否则返回错误码及错误信息。
添加数据签名任务
MSSPServer/biz/signjob/v1/addSignJob
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
dataType | String | 原文类型(HASH:哈希数据,PLAIN:原文数据) | 是 |
jobSignAlgo | String | 签名算法(SHA1withRSA SHA256withRSA SM3withSM2) | 是 |
description | String | 描述 | 否 |
msspId | String | 用户编号,发起任务时无法确定签名者,此项可以为空 | 否 |
expiryDate | String | 有效期:单位分钟,默认三天 | 否 |
data | String | 待签数据(Base64格式) | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 |
---|---|---|
signJobId | 签名任务ID | String |
qrCode | 二维码信息 | String |
获取签名结果
注意:复用“查询认证任务结果”接口queryAuthJob 。
MSSPServer/biz/signjob/v1/querySignJob
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
signJobId | String | 签名任务ID | 是 |
业务响应参数
名称 | 类型 | 描述 |
---|---|---|
signStatus | String | 任务状态 |
signCert | String | 签名证书 |
signData | String | 签名原文的base64 |
msspId | String | 签名用户编号 |
signResult | String | 签名值 |
任务状态含义说明:
WAITING_USER_SIGN:任务尚未签署
USER_SIGN_FINISH:任务签署完成,完成状态才能获取到签名结果
TIMEOUT:任务超期,已经无法签署
4.3 其他接口
更新用户激活码
MSSPServer/biz/user/v1/updateAuthCode
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
authCode | 授权码 | String | 是 |
qrCode | 二维码信息 | String | 是 |
查询用户设备列表
MSSPServer/biz/user/v1/listUserDevice
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
deviceList | 用户设备列表 | List |
是 |
附:DeviceInfo对象属性信息
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
deviceName | 设备名称 | String | 是 |
id | 设备ID | String | 是 |
date | 设备激活时间 | String | 是 |
deviceStatus | 设备状态 | String | 是 |
查询用户设备证书
MSSPServer/biz/user/v1/listUserDeviceCert
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号 | 是 |
mobileId | String | 设备编号(即deviceId) | 否,为空时查询托管密钥信息 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
certList | 用户设备列表 | List |
是 |
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
deviceId | 设备ID | String | 否,请求参数 mobileId不传时 |
certGenType | 证书密钥类型 | String | 是(COORDINATION 协同/AUTHORIZE 托管) |
algoPolicy | 证书算法 | String | 是(RSA / SM2) |
useage | 密钥用法 | String | 是(AUTH / SIGN) |
cert | 证书内容 | String,Base64格式 | 是 |
附:UserCertInfo对象属性信息
个人托管密钥数据签名
MSSPServer/biz/signjob/v1/authorizeSignData
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
dataType | String | 原文类型(HASH:哈希数据,PLAIN:原文数据) | 是 |
jobSignAlgo | String | 签名算法 | 是 |
description | String | 描述 | 否 |
msspId | String | 用户编号,发起任务时无法确定签名者,此项可以为空 | 是 |
data | String | 待签数据(Base64格式) | 是 |
challengeData | String | 挑战验证信息,根据策略配置决定是否使用,内容是Map<String, String>格式的对象转换成的JSON数据 | 否 |
附:挑战验证信息类型及使用说明
验证类型key值 | 类型 | 描述 | 必须 |
---|---|---|---|
ENCPIN | String | PIN口令验证,验证对象是用户的PIN口令 | 否 |
CHALLENGE_SIGN | String | 协同密钥签名验证,验证对象为完成的协同密钥挑战签名任务ID | 否 |
FACE_RECOGNITION | String | 人脸比对验证,验证内容为用户人脸照片,通过手机端SDK接口获取 | 否 |
CHALLENGE_OTP | String | 短信验证码验证,验证内容为短信验证码,需要与下面的ID配合使用 | 否 |
OTP_ID | String | challengeOtp接口返回的挑战码ID | 否 |
多种验证方式可以组合使用。
业务响应参数
名称 | 类型 | 描述 |
---|---|---|
signJobId | String | 签名任务ID |
signStatus | String | 任务状态 |
signCert | String | 签名证书 |
msspId | String | 签名用户编号 |
signResult | String | 签名值 |
发起个人手机挑战码验证
MSSPServer/biz/signjob/v1/challengeOtp
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号,要进行挑战码验证的用户,系统会将短信直接发送到用户在系统中登记的手机号 | 是 |
description | String | 验证是由说明 | 否 |
业务响应参数
名称 | 类型 | 描述 |
---|---|---|
challengeId | String | 验证任务ID |
order | String | 验证码序数 |
更新个人用户托管密钥
MSSPServer/biz/user/v1/updateAuthorizeCert
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号,要更新托管密钥的用户ID | 是 |
encPin | String | 用户初始PIN口令,使用PIN口令验证时必传,如该项未设置,该用户将无法自行修改PIN口令,只能下次更新托管密钥时重新设置PIN口令 | 否 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
certList | 用户设备列表 | List |
是 |
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
deviceId | 设备ID | String | 是 |
certGenType | 证书密钥类型 | String | 是(COORDINATION 协同/AUTHORIZE 托管) |
algoPolicy | 证书算法 | String | 是(RSA / SM2) |
useage | 密钥用法 | String | 是(AUTH / SIGN) |
cert | 证书内容 | String,Base64格式 | 是 |
附:UserCertInfo对象属性信息
修改个人用户托管密钥口令
MSSPServer/biz/user/v1/updateAuthorizeCertPin
业务请求参数
名称 | 类型 | 描述 | 必须 |
---|---|---|---|
msspId | String | 用户编号,要更新托管密钥的用户ID | 是 |
oldPin | String | 用户原有PIN口令,验证通过后才能修改 | 是 |
newPin | String | 新的PIN口令 | 是 |
业务响应参数
判断接口调用成功即表示修改成功。
时间戳签名服务
请求地址:tss/v1/signtss
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
algo | String | 是 | 证书算法(RSA/SM2) |
data | String | 是 | 待签数据base64 |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | OnceCertResponse | 否 | 返回业务数据 |
signature | String | 否 | 签名结果 |
time | String | 否 | 时间信息,格式为:2020-07-14 09:39:56 |
version | String | 是 | 版本号(2.0) |
signJobId | String | 否 | 签名任务Id |
时间戳验签服务
请求地址:tss/v1/verifytss
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
algo | String | 是 | 证书算法(RSA/SM2) |
data | String | 是 | 签名原文base64 |
tssSignature | String | 是 | 签名值 |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | OnceCertResponse | 否 | 返回业务数据 |
version | String | 否 | 版本号(2.0) |
result | int | 否 | 验签结果(1为成功,-1 ,时间戳签名结果不正确,-2原文有变化) |
time | String | 否 | 时间信息,如:2020-07-14 09:39:56 |
证书解析
**MSSPServer/**biz/verify/v1/certParser
业务请求参数
名称 | 类型 | 描述 | 是否必须 |
---|---|---|---|
cert | String | 证书,base64编码 | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
serialNumber | 序列号 | String | 是 |
signatureAlgorithm | 签名算法 | String | 是,如:SHA1WITHRSA |
issuerDN | 颁发者 | String | 是,如BJCA测试证书DN:(C=CN,O=BJCA,CN=mssptestca) |
startTime | 有效期起始时间 | String | 是,如:2020-05-12 14:55:29 |
endTime | 有效期结束时间 | String | 是 |
certUserDN | 使用者dn | String | 是,个人证书里签了msspId,如:(C=CN,CN=秦祝成,UID=90add37a73d8cb3a37c63280aeb3f625c64f5a4fd00e51dceb731b12076d6903) |
publicKey | 公钥 | String | 是 |
publicKeyAlgorithm | 公钥算法 | String | 是,如:RSA |
keyUsage | 密钥用法 | String | 否,如:Digital Signature (80) |
uid | String | 否 | |
issuerUniqueId | String | 否 | |
subjectUniqueId | String | 否 | |
certExt | 证书扩展项 | Map<String,String> | 否,申请证书时扩展项传入什么,这里就会返回什么 |
添加认证任务,外传待签数据
MSSPServer/biz/signjob/v1/addAuthData
业务请求参数
名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
jobSignAlgo | 签名算法(SHA1withRSA SHA256withRSA SM3withSM2) | String | 是 |
description | 描述(Base64格式) | String | 否 |
msspId | 用户编号,发起任务时无法确定签名者,此项可以为空 | String | 否 |
expiryDate | 有效期:单位分钟,默认一小时 | String | 否 |
data | 待签数据(Base64格式) | String | 是 |
dataType | 原文类型(HASH:哈希数据,PLAIN:原文数据) | String | 是 |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
signJobId | 签名任务ID | String | 否 |
signData | 待签数据(Base64格式) | String | 否 |
qrCode | 二维码信息 | String | 否 |
长效证书申请接口
cert/v2/applycert
业务请求参数
名称 | 字段描述 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
name | 证书持有名称(单位或个人) | String | 是 | 张三或北京数字认证股份有限公司 |
idCard | 证件号码 | String | 是 | 220101199001013212 |
idType | 证件号码类型:SF – 身份证JG – 军官证HZ – 护照HX – 回乡证JJ – 组织机构代码证 | String | 是 | SF |
mobile | 手机号 | String | 否 | 18611525990 |
certReq | 证书申请书 | String | 是 | Base64编码的P10请求 |
certTemplateId | 证书模板,根据客户需求向CA系统确定使用的模板名称。 | String | 否 | BJCA_RSA_1024 |
certExpire | 证书有效期,根据客户需求向CA系统确定使用的有效期。 | String | 否 | 365d, d表示天。默认365天。 |
certExt | 证书扩展 | String | 否 | 使用此参数可以在证书中签发出自定义扩展。使用前需要和CA服务人员确认此项参数如何定义。此参数是List的JSON字符串。列表中的没一项包括oid和oidValue,分别表示自定义扩展的id和值。例如:”[{"oid":"1.2.86.11.7.1.8","oidValue":"extValue1"},{"oid":"1.2.86.11.7.1.9","oidValue":" extValue2"}]” |
transId | 业务系统当前请求的交易号 | String | 是 | 20180613019201920001 |
extension | 扩展内容json | String | 否 | “{“key”:”value”}” |
业务响应参数
字段名称 | 字段描述 | 类型 | 是否必须 |
---|---|---|---|
requestId | 返回流水号 | String | 是 |
transId | 业务系统当前请求的唯一交易号 | String | 是 |
cert | 公钥证书 | String | 是 |
certSn | 证书序列号 | String | 是 |
错误码说明
错误码 | 描述 | 解决方案 |
---|---|---|
30304001 | 请求参数错误 | 检查请求参数是否正确 |
30304004 | 证书有效期格式错误 | 检查certExpire参数是否正确 |
30304005 | CA证书服务异常 | 联系系统管理员或客服 |
30304006 | 申请证书错误 | 联系系统管理员或客服 |
30304007 | 证书扩展参数格式错误 | 检查certExt参数是否正确 |
证书注销接口
业务请求参数
名称 | 字段描述 | 类型 | 是否必须 | 示例 |
---|---|---|---|---|
certSn | 证书序列号 | String | 是 | 200189a0f4bf0f63deebb9f6f186f92f4a7f |
transId | 业务系统当前请求的交易号 | String | 是 | 20180613019201920001 |
revokeReason | “1”- “密钥泄漏””2”- “CA 泄漏””3”-“附属关系已更改””4”- “被取代””5”- “停止操作””6”- “证书挂起” | String | 否 | 4 |
业务响应参数
返回公共响应参数,200,成功
错误码说明
错误码 | 描述 | 解决方案 |
---|---|---|
30304001 | 请求参数错误 | 检查请求参数是否正确 |
30304005 | CA证书服务异常 | 联系系统管理员或客服 |
30304008 | 证书不存在 | 确认证书序列号是否正确 |
30304009 | 注销证书错误 | 联系系统管理员或客服 |
申请事件型证书
请求地址:anysign/v2/cert/noEncCert
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
algo | String | 是 | 证书算法(RSA/SM2) |
bussinessId | String | 否 | 业务流水号 |
expDate | String | 否 | 证书到期时间(0-1440,整型,以分钟为单位) |
extInfo | String | 是 | 证书扩展项原文(不能超过500K),说明见附文 |
idCard | String | 是 | 申请人证件号 |
idCardType | String | 是 | 申请人证件类型(,SF – 身份证 JG – 军官证 HZ – 护照 HX – 回乡证 JJ – 组织机构代码证) |
mobile | String | 否 | 申请人手机号 |
name | String | 是 | 申请人姓名(最长255位) |
p10 | String | 是 |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | OnceCertResponse | 否 | 返回业务数据 |
transId | String | 否 | 证书ID |
certInfo | String | 否 | 证书信息 |
附文:(extInfo规范,按照下列格式传入)
附文代码折叠区域
{// |
添加企业
请求地址:enterInfo/v2/addEnterprise
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
bussinessId | String | 否 | 业务流水号 |
enterpriseName | String | 是 | 企业名称(最大长度64位) |
icRegistrationNum | String | 否 | 四个编号必填一个(最大长度64位) |
uniqueNum | String | 否 | |
organiazationCode | String | 否 | |
texationNum | String | 否 | |
legalPerson | String | 否 | 法人姓名(最大长度50位) |
legalPersonCard | String | 否 | 法人证件号码(最大长度32位) |
legalPersonCardType | String | 否 | 法人证件类型(身份证号为SF) |
mobile | String | 否 | 法人手机号码 |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | 否 | 返回业务数据 | |
enterpriseId | String | 否 | 企业ID |
请求企业托管证书
请求地址:enterInfo/v1/sign/queryEntP10
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
bussinessId | String | 否 | 业务流水号 |
algo | String | 是 | 申请证书算法(RSA或SM2) |
certDn | String | 否 | DN |
enterpriseId | String | 是 | 企业编号 |
keyLen | String | 是 | 密钥长度(RSA为1024或2048,SM为256) |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | EnterpristCert | 否 | 返回业务数据 |
keyId | String | 否 | 企业证书Id |
enterpriseCert | String | 否 | 企业证书 |
企业托管证书签名
请求地址:enterInfo/v1/sign/authTokenSign
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
bussinessId | String | 否 | 业务ID |
algo | String | 是 | 申请证书算法(SHA1withRSA、SHA256withRSA、SM3withSM2) |
data | String | 是 | 待签数据base64(最大500k) |
isHash | Boolean | 是 | 哈希标志 |
keyId | String | 是 | 密钥ID |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | EnterpristCert | 否 | 返回业务数据 |
signJobId | String | 否 | 签名任务Id |
signature | String | 否 | 签名结果 |
cert | longtext | 否 | 企业证书 |
查询
请求地址:enterInfo/v1/query
请求方式:POST
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
bussinessId | String | 否 | 业务流水号 |
id | String | 是 | Id |
type | String | 是 | 查询类型(SIGN、KEYADD_ENT) |
响应参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
status | int | 是 | 状态码(200成功) |
message | String | 是 | 状态信息 |
data | 否 | 返回业务数据 |