业务文档
业务文档
4.1 概述
前提条件:第三方应用在天威诚信电子认证云服务平台进行应用注册,获得应用标识和应用密钥。
异常相应结果参数及格式如下:
Ø status:状态码,1表示成功;小于1表示失败;
Ø message:对调用失败原因的描述;
4.2 通用约束
Ø 所有请求内容类型使用application/json;charset=UTF-8
Ø 所有涉及到编码的环节一律采用UTF-8(例如URLEncoding、String转byte[]等);
Ø 当接口参数为二进制字节数组时,一律Base64编码后再传递;
Ø 所有图片数据限制在2M以内;
4.3 安全性设计
通讯安全:
Ø 采用SSL安全连接,防止信息篡改、中间人窃听和重放攻击;
访问安全:
Ø 请求时,需要将appId(应用标识), serviceCode(产品编码),加入HTTP协议的HEADER中;
Ø 请求中请求方必须带Content-Signature签名值,签名的内容为“JSON格式的请求参数”,签名密钥为 “应用密钥+serviceCode ”,确保信息的不被篡改。
4.4 路径地址
测试地址:http://demo-open.itruscloud.com/apigate
正式地址:http://open.itruscloud.com/apigate
4.5 证书签发服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 签发证书 |
接口URL | /certservice/makeCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
csr | String | 4000 | 必选 | 证书请求CSR字符串类型 |
userName | String | 128 | 必选 | 姓名(企业名称) |
userSurname | String | 128 | 可选 | 别名 |
userEmail | String | 64 | 可选 | 邮箱 |
userOrganization | String | 128 | 可选 | 单位 (系统默认,不传值) |
userOrgunit | String | 128 | 可选 | 部门(系统默认,不传值) |
userCountry | String | 128 | 可选 | 国家 |
userState | String | 128 | 可选 | 省 |
userLocality | String | 128 | 可选 | 市 |
userStreet | String | 128 | 可选 | 街道 |
userTitle | String | 128 | 可选 | 职位 |
userAdditionalField1 | String | 4000 | 可选 | 备用字段1,用于拓展用户信息 |
userAdditionalField2 | String | 4000 | 可选 | 备用字段 |
userAdditionalField3 | String | 4000 | 可选 | 备用字段 |
userAdditionalField4 | String | 4000 | 可选 | 备用字段 |
userAdditionalField5 | String | 4000 | 可选 | 备用字段 |
userAdditionalField6 | String | 4000 | 可选 | 备用字段 |
checkAgreeMent | boolean | 可选 | 是否勾选电子认证协议 | |
customdays | Integer | 可选 | 自定义天数 | |
orderNumber | String | 可选 | 申请证书唯一流水号(合规配置配置日志确认方式,参数必传) | |
agreementConfirmWay | String | 128 | 可选 |
协议确认方式,(合规配置配置日志确认方式,参数必传) CHECK_CONFIRM : 勾选确认, SMS_CONFIRM : 短信确认, OTHER_CONFIRM : 其他
|
wishVerifyWay | String | 128 | 可选 | 意愿验证方式,(合规配置配置日志确认方式,参数必传), CHECK_VERIFY : 勾选验证, SMS_VERIFY : 短信验证, FACE_VERIFY : 人脸验证, OTHER_VERIFY : 其他; |
agreementSystemName | String | 128 | 可选 | 使用协议系统名称,(合规配置配置日志确认方式,参数必传)如:上上签电子合同 |
businessSystemId | String | 128 | 可选 | 业务系统ID,(合规配置配置日志确认方式,参数必传),由业务系统指定 |
userIdentityId | String | 可选 | 用户身份ID,(合规配置配置日志确认方式,个人证书参数必传,企业证书参数非必传) |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, 其他表示处理失败 |
message | String | 对应状态信息说明 或 失败原因 |
data | Json | orderNumber:流水号, buf:证书buf, bufP7:证书bufP7, certDn:证书DN, certSn:证书SN, issuerDn:颁发者DN, endTime:证书有效期结束日期 certSignBufKmc: 用户加密证书 certSnKmc: 用户加密证书序列号 certKmcRep1:KMC 协议响应 1
|
输出示例 | {"status":1, "data":{"orderNumber":"" "buf":"", "bufP7":"", "certDn":"", "certSn":"", "issuerDn":"", "startTime":"", "endTime":"", "certSignBufKmc":"", "certSnKmc":"", "certKmcRep1":"" } } |
4.6 证书更新服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 证书更新 |
接口URL | /certservice/updateCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
crt | String | 5500 | 必选 | 证书base64 |
newCSR | String | 4000 | 必选 | 原证书所在容器生成的新的证书请求 |
pkcs7 | String | -- | 必选 | 老证书对csr签名后的base64字符串 |
certSn | String | 64 | 必选 | 老证书的证书请求信息 |
checkAgreeMent | boolean | 可选 | 是否勾选电子认证协议 | |
customdays | Integer | 可选 | 自定义天数 | |
orderNumber | String | 可选 | 申请证书唯一流水号(合规配置配置日志确认方式,参数必传) | |
agreementConfirmWay | String | 128 | 可选 | 协议确认方式,(合规配置配置日志确认方式,参数必传) CHECK_CONFIRM : 勾选确认, SMS_CONFIRM : 短信确认, OTHER_CONFIRM : 其他 |
wishVerifyWay | String | 128 | 可选 | 意愿验证方式,(合规配置配置日志确认方式,参数必传), CHECK_VERITFY : 勾选验证, SMS_VERIFY : 短信验证, FACE_VERIFY : 人脸验证, OTHER_VERIFY : 其他; |
agreementSystemName | String | 128 | 可选 | 使用协议系统名称,(合规配置配置日志确认方式,参数必传)如:上上签电子合同 |
businessSystemId | String | 128 | 可选 | 业务系统ID,(合规配置配置日志确认方式,参数必传),由业务系统指定 |
userIdentityId | String | 可选 | 用户身份ID,(合规配置配置日志确认方式,个人证书参数必传,企业证书参数非必传) |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, 其他表示处理失败 |
message | String | 对应状态信息说明 或 失败原因 |
data | Json | orderNumber:流水号, buf:证书buf, bufP7:证书bufP7, certDn:证书DN, certSn:证书SN, issuerDn:颁发者DN, startTime:证书有效期开始日期, endTime:证书有效期结束日期, certSignBufKmc: 用户加密证书, certSnKmc: 用户加密证书序列号, certKmcRep1:KMC 协议响应 1
|
输出示例 | {"status":1, "data":{"orderNumber":"" "buf":"", "bufP7":"", "certDn":"", "certSn":"", "issuerDn":"", "startTime":"", "endTime":"", "certSignBufKmc":"", "certSnKmc":"", "certKmcRep1":"" } } |
4.7 证书吊销服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 证书吊销 |
接口URL | /certservice/revokeCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
orderNumber | String | 25 | 必选 | 流水号 |
certSn | String | 64 | 必选 | 证书序列号 |
revokeReason | String | 128 | 必选 | 吊销原因 |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, status的值为0表示处理失败 |
message | String | 失败原因 |
4.8 证书查询服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 证书查询 |
接口URL | /certservice/ queryCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
orderNumber | String | 25 | 必选 | 流水号,证书申请或更新产生的流水号 (orderNumber 与 applyTime 二选一) |
certSn | String | 64 | 可选 | 证书序列号 |
applyTime | String | 128 | 可选 | 证书申请时间 格式:yyyy-MM-dd (orderNumber 与 applyTime 二选一) |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, status的值为0表示处理失败 |
message | String | 返回消息 |
queryInfo | QueryCertResult | 证书信息及用户信息集合 |
QueryCertResult类型结构:
名称 | 类型 | 描述 |
totalSize | int | 返回数据总数 |
userInfos | Arrays of certInfo | 证书信息 |
userInfos | Arrays of userInfo | 用户信息 |
certInfo类型:
名称 | 类型 | 描述 |
certStatus | String | 证书状态 (VALID:有效;REVOKE:吊销;SUSPEND:挂起;EXPIRED:过期) |
certReqDate | String | 申请日期 |
certReqTransid | String | 交易号 |
certReqNonce | String | 随机数 |
certReqBufType | String | 证书请求类型 |
certReqChallenge | String | 用户口令 |
certReqComment | String | 证书请求备注 |
certApproveDate | String | 批准日期 |
certRejectDate | String | 拒绝日期 |
certSignDate | String | 签发日期 |
certSerialNumber | String | 用户证书序列号 |
certNotBefore | String | 开始日期 |
certNotAfter | String | 结束日期 |
certIssuerHashMd5 | String | 颁发者HASH |
certIssuerDn | String | 颁发者DN |
certSubjectHashMd5 | String | 使用者HASH |
certSubjectDn | String | 使用者DN |
certSuspendDate | String | 挂起日期 |
certRevokeDate | String | 吊销日期 |
certRevokeReason | String | 吊销原因 |
certRenewalDate | String | 更新日期 |
certRenewalPrevId | Int | 被更新证书ID |
certRenewalNextId | Int | 更新证书ID |
certReqOverrideValidity | Int | 用户证书有效期 |
certReqBuf | String | 用户证书请求 |
certSignBuf | String | 用户证书 |
certPin | String | 身份识别码 |
certType | String | 证书类型 |
certKmcReq1 | String | KMC协议请求1 |
certKmcReq2 | String | KMC协议请求2 |
certKmcReq3 | String | KMC协议请求3 |
certKmcRep1 | String | KMC协议响应1 |
certKmcRep2 | String | KMC协议响应2 |
certKmcRep3 | String | KMC协议响应3 |
certDeliverMode | String | 证书签发方式 |
certApproveAdmin1 | String | 批准管理员标识 |
certApproveAdmin2 | String | 审核管理员标识 |
certReqBufKmc | String | KMC证书请求 |
certReqBufTypeKmc | String | KMC证书请求类型 |
certSignBufKmc | String | 用户加密证书 |
certSignBufP7Kmc | String | 用户加密证书PKCS7格式(含证书链) |
certSignBufP7 | String | 用户证书PKCS7格式(含证书链) |
certSerialnumberKmc | String | 用户加密证书序列号 |
certTypeKmc | String | 用户加密证书类型 |
certReqPublickey | String | 用户证书请求公钥 |
certReqPublickeyHashMd5 | String | 用户证书请求公钥HASH |
userInfo类型:
名称 | 类型 | 描述 |
accountId | int | 帐户ID |
userName | String | 姓名 |
userSurname | String | 别名 |
userSerialnumber | String | 序号 |
userEmail | String | 邮箱 |
userOrganization | String | 单位 |
userOrgunit | String | 部门 |
userCountry | String | 国家 |
userState | String | 省 |
userLocality | String | 市 |
userStreet | String | 街道 |
userDns | String | DNS |
userIp | String | IP |
userTitle | String | 职位 |
userDescription | String | 描述 |
userAdditionalField1 | String | 备用字段1 |
userAdditionalField2 | String | 备用字段2 |
userAdditionalField3 | String | 备用字段3 |
userAdditionalField4 | String | 备用字段4 |
userAdditionalField5 | String | 备用字段5 |
userAdditionalField6 | String | 备用字段6 |
userAdditionalField7 | String | 备用字段7 |
userAdditionalField8 | String | 备用字段8 |
userAdditionalField9 | String | 备用字段9 |
userAdditionalField10 | String | 备用字段10 |
输出示例:
{
"status":1,
"queryInfo":{
"totalSize":0,
"certInfos":[
{
"certStatus":"REVOKE",
"certReqDate":"20230919162102",
"certReqBufType":"PKCS10",
"certReqChallenge":"yAUqysPhkHLcmV72oDXz+AW52oI=",
"certSignDate":"20230919162102",
"certSerialNumber":"313FF7E6D9DFE026B30BEABBD8A29AC1264776D0",
"certNotBefore":"20230919162101",
"certNotAfter":"20240929161909",
"certIssuerHashMd5":"",
"certIssuerDn":"CN=天威诚信数字认证中心CA, OU=SM2证书系统, O=北京天威诚信电子商务服务有限公司, C=CN",
"certSubjectHashMd5":"",
"certSubjectDn":"CN=深圳市腾讯科技有限公司测试, SERIALNUMBER=IDnum:12**********bc, OU=test@qq.com, OU=广西壮族自治区大数据发展局(中国—东盟信息港建设办公室、广西壮族自治区政务服务监督管理办公室), O=北京天威诚信电子商务服务有限公司",
"certRevokeDate":"20230919162502",
"certRevokeReason":"unknown",
"certRenewalDate":"20230919162102",
"certRenewalPrevId":0,
"certRenewalNextId":0,
"certReqOverrideValidity":375,
"id":0,
"certReqBuf":"MIIBBjCBrQIBADBLMQswCQYDVQQGDAJDTjEMMAoGA1UEAwwDZ3dtMREwDwYDVQQHDAhIb25nS29uZzEMMAoGA1UECgwDSVQuMQ0wCwYDVQQLDAREZXB0MFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAE4lnHjxQWCTLqV8LtWtihZER+cIa+YVWkBrF2HRCh/ZFMhxeyzfGN7l/w8b3ttWj2qRWFTbJ75DMAWDOTfLTlU6AAMAoGCCqBHM9VAYN1A0gAMEUCIBd6tw57tmlcBr8ewtpvUsFTKdBGUls1scj7W4L4hOkzAiEA8ORM0PV3oKBdLv1PYPFeyWcaRiYkkc0szFacEbecXVk=",
"certSignBuf":"MIIDjjCCAzKgAwIBAgIUMT/35tnf4CazC+q72KKawSZHdtAwDAYIKoEcz1UBg3UFADCBjTELMAkGA1UEBhMCQ04xOTA3BgNVBAoMMOWMl+S6rOWkqeWogeivmuS/oeeUteWtkOWVhuWKoeacjeWKoeaciemZkOWFrOWPuDEYMBYGA1UECwwPU00y6K+B5Lmm57O757ufMSkwJwYDVQQDDCDlpKnlqIHor5rkv6HmlbDlrZforqTor4HkuK3lv4NDQTAeFw0yMzA5MTkwODIxMDFaFw0yNDA5MjkwODE5MDlaMIIBPTE5MDcGA1UECgww5YyX5Lqs5aSp5aiB6K+a5L+h55S15a2Q5ZWG5Yqh5pyN5Yqh5pyJ6ZmQ5YWs5Y+4MYGYMIGVBgNVBAsMgY3lub/opb/lo67ml4/oh6rmsrvljLrlpKfmlbDmja7lj5HlsZXlsYDvvIjkuK3lm73igJTkuJznm5/kv6Hmga/muK/lu7rorr7lip7lhazlrqTjgIHlub/opb/lo67ml4/oh6rmsrvljLrmlL/liqHmnI3liqHnm5HnnaPnrqHnkIblip7lhazlrqTvvIkxFDASBgNVBAsMC3Rlc3RAcXEuY29tMR0wGwYDVQQFDBRJRG51bToxMioqKioqKioqKipiYzEwMC4GA1UEAwwn5rex5Zyz5biC6IW+6K6v56eR5oqA5pyJ6ZmQ5YWs5Y+45rWL6K+VMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAE4lnHjxQWCTLqV8LtWtihZER+cIa+YVWkBrF2HRCh/ZFMhxeyzfGN7l/w8b3ttWj2qRWFTbJ75DMAWDOTfLTlU6OBujCBtzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE8DCBnAYDVR0fBIGUMIGRMIGOoIGLoIGIhoGFaHR0cDovL3RvcGNhLml0cnVzLmNvbS5jbi9wdWJsaWMvaXRydXNjcmw/Q0E9MkEwOTdDMkQzQzZEMEE3NjA1QUZGNTREOTIyRjk4Q0QwNDkwQTMyQiZzZz1IQUNDNzZBMkZGRDM2RTI2NzQ1NjZFMzNFRTE4NzBFMUJGQkM3MzVGQjRCNjAMBggqgRzPVQGDdQUAA0gAMEUCIB0Cau6jlbe+FAekiLZcJ/h27KQG8MMIfz0+sflfOehCAiEApjSd9tUWFK2hLIdeMT9KewpdJnAdlgRDaqP1aiwOS8E=",
"certType":"enccert",
"certKmcRep1":"userSeal=MHkCIQCJlz0R0VgBT9AzJx64YZpW2ZntTnSsrLP52iXEA2F51wIgAuLJSc%2F10rTHA6jbczs1sQzGZgOnzsxHE%2Ff4gbRHHkoEIJESsiudOzPeYj9pFibFvNtL7%2FPW0ji5IGfdKM%2FZlDIpBBC4FSOUKmBJWLUCveiNpuQ4&encPrivateKeyUser=dm6PrrWhnv7uyEvmZFay%2BJmdkisQhIy6JcRpI2MxGkZigNzyeH5RdcXatACiPRzq&KEY_ID=107356231&userIV=1qR%2B9H1F81O8TSHEeMgUBg%3D%3D&userCipher=AES",
"certKmcRep2":"MIIDpDCCA0mgAwIBAgIUSe0IepYVnwj+YNvSdQ2o70/qg3swDAYIKoEcz1UBg3UFADCBjTELMAkGA1UEBhMCQ04xOTA3BgNVBAoMMOWMl+S6rOWkqeWogeivmuS/oeeUteWtkOWVhuWKoeacjeWKoeaciemZkOWFrOWPuDEYMBYGA1UECwwPU00y6K+B5Lmm57O757ufMSkwJwYDVQQDDCDlpKnlqIHor5rkv6HmlbDlrZforqTor4HkuK3lv4NDQTAeFw0yMzA5MTkwODIxMDFaFw0yNDA5MjkwODE5MDlaMIIBPTE5MDcGA1UECgww5YyX5Lqs5aSp5aiB6K+a5L+h55S15a2Q5ZWG5Yqh5pyN5Yqh5pyJ6ZmQ5YWs5Y+4MYGYMIGVBgNVBAsMgY3lub/opb/lo67ml4/oh6rmsrvljLrlpKfmlbDmja7lj5HlsZXlsYDvvIjkuK3lm73igJTkuJznm5/kv6Hmga/muK/lu7rorr7lip7lhazlrqTjgIHlub/opb/lo67ml4/oh6rmsrvljLrmlL/liqHmnI3liqHnm5HnnaPnrqHnkIblip7lhazlrqTvvIkxFDASBgNVBAsMC3Rlc3RAcXEuY29tMR0wGwYDVQQFDBRJRG51bToxMioqKioqKioqKipiYzEwMC4GA1UEAwwn5rex5Zyz5biC6IW+6K6v56eR5oqA5pyJ6ZmQ5YWs5Y+45rWL6K+VMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAErgK7iNMSVNadEzgfoGQ18S4w3GN9lliulIZlocwmWOElIMZAeT2vO9H6mO0KKS7qBAOGSOwGJMVYVNq4orCRQ6OB0TCBzjAJBgNVHRMEAjAAMAsGA1UdDwQEAwIFIDCBnAYDVR0fBIGUMIGRMIGOoIGLoIGIhoGFaHR0cDovL3RvcGNhLml0cnVzLmNvbS5jbi9wdWJsaWMvaXRydXNjcmw/Q0E9MkEwOTdDMkQzQzZEMEE3NjA1QUZGNTREOTIyRjk4Q0QwNDkwQTMyQiZzZz1IQUNDNzZBMkZGRDM2RTI2NzQ1NjZFMzNFRTE4NzBFMUJGQkM3MzVGQjRCNjAVBgdggRwBBgoCBAoMCElUUlVTS01DMAwGCCqBHM9VAYN1BQADRwAwRAIgNZBOzVlY4fkzmQMyokNiwjWKzlNU5rlVZZHFpFvM5ncCIDId2bX4XGescLFhaBIPruBMFkTwovtMCwzvl5+4+Irm",
"certKmcRep3":"49ED087A96159F08FE60DBD2750DA8EF4FEA837B",
"certDeliverMode":"",
"certRenewemailDeliver":"0",
"certReqBufTypeKmc":"PKCS10",
"certSignBufKmc":"MIIDpDCCA0mgAwIBAgIUSe0IepYVnwj+YNvSdQ2o70/qg3swDAYIKoEcz1UBg3UFADCBjTELMAkGA1UEBhMCQ04xOTA3BgNVBAoMMOWMl+S6rOWkqeWogeivmuS/oeeUteWtkOWVhuWKoeacjeWKoeaciemZkOWFrOWPuDEYMBYGA1UECwwPU00y6K+B5Lmm57O757ufMSkwJwYDVQQDDCDlpKnlqIHor5rkv6HmlbDlrZforqTor4HkuK3lv4NDQTAeFw0yMzA5MTkwODIxMDFaFw0yNDA5MjkwODE5MDlaMIIBPTE5MDcGA1UECgww5YyX5Lqs5aSp5aiB6K+a5L+h55S15a2Q5ZWG5Yqh5pyN5Yqh5pyJ6ZmQ5YWs5Y+4MYGYMIGVBgNVBAsMgY3lub/opb/lo67ml4/oh6rmsrvljLrlpKfmlbDmja7lj5HlsZXlsYDvvIjkuK3lm73igJTkuJznm5/kv6Hmga/muK/lu7rorr7lip7lhazlrqTjgIHlub/opb/lo67ml4/oh6rmsrvljLrmlL/liqHmnI3liqHnm5HnnaPnrqHnkIblip7lhazlrqTvvIkxFDASBgNVBAsMC3Rlc3RAcXEuY29tMR0wGwYDVQQFDBRJRG51bToxMioqKioqKioqKipiYzEwMC4GA1UEAwwn5rex5Zyz5biC6IW+6K6v56eR5oqA5pyJ6ZmQ5YWs5Y+45rWL6K+VMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAErgK7iNMSVNadEzgfoGQ18S4w3GN9lliulIZlocwmWOElIMZAeT2vO9H6mO0KKS7qBAOGSOwGJMVYVNq4orCRQ6OB0TCBzjAJBgNVHRMEAjAAMAsGA1UdDwQEAwIFIDCBnAYDVR0fBIGUMIGRMIGOoIGLoIGIhoGFaHR0cDovL3RvcGNhLml0cnVzLmNvbS5jbi9wdWJsaWMvaXRydXNjcmw/Q0E9MkEwOTdDMkQzQzZEMEE3NjA1QUZGNTREOTIyRjk4Q0QwNDkwQTMyQiZzZz1IQUNDNzZBMkZGRDM2RTI2NzQ1NjZFMzNFRTE4NzBFMUJGQkM3MzVGQjRCNjAVBgdggRwBBgoCBAoMCElUUlVTS01DMAwGCCqBHM9VAYN1BQADRwAwRAIgNZBOzVlY4fkzmQMyokNiwjWKzlNU5rlVZZHFpFvM5ncCIDId2bX4XGescLFhaBIPruBMFkTwovtMCwzvl5+4+Irm",
"certSerialnumberKmc":"49ED087A96159F08FE60DBD2750DA8EF4FEA837B",
"certIdRandom":""
}
],
"userInfos":[
{
"accountId":9109,
"userName":"深圳市腾讯科技有限公司测试",
"userSerialnumber":"313FF7E6D9DFE026B30BEABBD8A29AC1264776D0",
"userOrganization":"北京天威诚信电子商务服务有限公司",
"userOrgunit":"广西壮族自治区大数据发展局(中国—东盟信息港建设办公室、广西壮族自治区政务服务监督管理办公室)",
"userAdditionalField1":"test@qq.com",
"userAdditionalField9":"1",
"userAdditionalField10":"12345678990abc"
}
]
}
}
4.9 证书挂起服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 证书挂起 |
接口URL | /certservice/ suspendCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
orderNumber | String | 25 | 必选 | 流水号 |
certSn | String | 64 | 必选 | 证书序列号 |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, status的值为0表示处理失败 |
message | String | 失败原因 |
4.10 证书解挂服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 证书解挂 |
接口URL | /certservice/ unSuspendCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
orderNumber | String | 25 | 必选 | 流水号 |
certSn | String | 64 | 必选 | 证书序列号 |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, status的值为0表示处理失败 |
message | String | 失败原因 |
4.11 证书补发服务接口定义
基本信息:
名称 | 内容 |
接口说明 | 证书补发 |
接口URL | /certservice/ reIssueCert |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
orderNumber | String | 25 | 必选 | 流水号 |
certSn | String | 64 | 必选 | 证书序列号 |
csr | String | 64 | 必选 | 证书请求CSR字符串类型 |
useExistingKeySet | Boolean | 1 | 可选 | 是否使用原密钥补发,默认true |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, status的值为0表示处理失败 |
message | String | 失败原因 |
data | json | "orderNumber":"" "buf":"", "bufP7":"", "certDn":"", "certSn":"", "issuerDn":"", "startTime":1578553378000, "endTime":1578553378000, "certSignBufKmc":"", "certSnKmc":"", "certKmcRep1":"" |
4.12 证书获取协议接口定义
基本信息:
名称 | 内容 |
接口说明 | 获取协议 |
接口URL | /certservice/ getAgreement |
请求方式 | GET/POST |
应答格式 | JSON |
HEAD参数 | Content-Signature:“HMAC-SHA1 ”加hmac签名值,采用HmacSHA1算法 |
请求参数:
名称 | 类型 | 长度 | 约束 | 描述 |
productCode | String | 必选 | 产品编码 |
返回值:
名称 | 类型 | 描述 |
status | String | status的值为1表示处理正常, 其他表示处理失败 |
message | String | 对应状态信息说明 或 失败原因 |
data | Json | { "status": 1, "message": "获取协议成功", "data": { "orderNumber": "zte202310261040025908657", "agreementUrl": "http://192.168.100.120:1047/itruscloud/agreement/itruscloud_private_agreement.pdf" } } |
4.13 错误码
错误分类 | 错误码 | 描述 |
系统错误 | 100000 | 无可用信任源 |
100001 | 信任源异常错误,请联系管理员 | |
100002 | 参数错误非空验证 | |
100003 | 系统异常错误 | |
100004 | 没有此服务权限 | |
100005 | 服务密钥错误 | |
100006 | Hmac验证错误 | |
100008 | 接口调用异常 | |
100009 | 缺少服务配置 | |
100010 | 应用标识不存在 | |
100011 | 应用状态已关闭 | |
100012 | 应用服务不存在 | |
100013 | 服务已关闭 | |
100014 | 未找到方法 | |
签发 | 101001 | 缺少证书配置 |
101002 | 缺少ra配置 | |
101003 | Ra系统错误(缺少必要参数,AA拒绝等……) | |
101004 | 系统错误 | |
101005 | 接口异常 | |
101006 | 缺少客户自定义配置 | |
101007 | 未找到配置的企业信息 | |
101008 | 参数校验失败的信息,(不固定) | |
101009 | 不可使用RSA算法的产品签发SM2算法证书,反之同理 | |
更新 | 102001 | 没有找到和证书序列号匹配的证书信息 |
102002 | 未找到证书关联的ra信息 | |
102003 | 缺少证书配置 | |
102004 | 系统异常(ra系统抛出的异常) | |
102005 | 接口异常(接口本身的错误) | |
102006 | 更新产品与证书产品不符 | |
102007 | 传入的certSn 与要更新的证书certSn不匹配 | |
吊销 | 103001 | 没有找到和证书序列号匹配的证书信息 |
103002 | 未找到证书关联的ra信息 | |
103003 | 证书已过期无法吊销 | |
103004 | 接口其他错误 |