API接口文档

证书签发-个人证书授权日志创建

传入身份信息，获取个人证书授权码。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： personal.authorization.logs
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	PersonalAuthorizationLogsRequest	是	个人授权日志请求

PersonalAuthorizationLogsRequest 说明:

名称	类型	是否必须	描述
idType	IdType	是	证件类型
idNumber	String	是	证件号,需要与证件类型匹配
name	String	是	证书持有者姓名
faceImage	String	是	人脸图片（base64格式）
announcementReadStartTime	Long	是	CA申请公告阅读开始时间（时间戳格式）
announcementConfirmTime	Long	是	CA申请公告确认时间（时间戳格式）
verificationTime	Long	是	人脸核验时间（时间戳格式）
agreementConfirmTime	Long	是	协议确认时间（时间戳格式）

证件类型(IdType)说明:

名称	描述
ID	身份证
PASSPORT	护照
MILITARY_ID	军人身份证
BUSINESS_REGISTRATION_CERT	工商登记证
TAX_REGISTRATION_CERT	税务登记证
SHAREHOLDER_CODE_CERT	股东代码证
SOCIAL_SECURITY_CARD	社会保障卡
ARMED_POLICE	武装警察身份证件
HK_MACAU_PASSPORT	港澳居民往来内地通行证
TAIWAN_PASSPORT	台湾居民往来内地通行证
HOUSEHOLD_REGISTER	户口簿
TEMPORARY_ID	临时身份证
POLICE_CERT	警官证
PERMANENT_RESIDENCE_PERMIT	外国人永久居留证
GOVERNMENT_APPROVAL	政府批文
UNIFIED_SOCIAL_CERT	统一社会信用代码证
PRIVATE_NON_ENTERPRISE_CERT	民办非企业登记证书
CORPORATE_CERT	法人证书
OTHER	其他

三、响应参数

data 结果信息	类型	描述
message	String	业务描述
incorrect	String	业务返回码
authorizationCode	String	授权码

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "message":"success",
    "incorrect": 0,
    "authorizationCode":'20251208xxx...'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '' ,
      "incorrect": 1
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	获取成功
其它	错误信息

证书签发-个人证书

传入身份信息，进行证书的申请和签发。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： issue.personal.senior
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	PersonalIssueRequest	是	个人高级证书签发请求

PersonalIssueRequest 说明:

名称	类型	是否必须	描述
personalSeniorCertificate	PersonalSeniorCertificate	是	个人高级证书实体信息
pkCS10	String	是	用于制作证书的 pkCS10
extensions	Map	否	扩展属性
agentInfo	AgentInfo	否	经办人信息(非合约用户必传经办人手机号)
duration	String	否	证书有效期，格式为数字+字母，字母支持YMDHm，分别对应年月日时分，不传默认1Y。

extensions 说明：

名称	key	value	描述及示例
赠送时间	preTime	赠送时长	数字+字母（Y/M）例: “12M”12个月，”1Y”1年，赠送时长不得超过一年。

PersonalSeniorCertificate (继承自 BaseCertificate) 说明:

名称	类型	是否必须	描述
idType	IdType	是	证件类型
idNumber	String	是	证件号,需要与证件类型匹配
phoneNumber	String	否	联系号码
ownerName	String	否	证书持有者姓名
authorizationCode	String	否	授权码

BaseCertificate 说明:

名称	类型	是否必须	描述
commonName	String	否	证书 CN 项,证书持有者名称
organization	String	否	证书 O 项,证书所属组织
organizationUnit	String	否	证书 OU 项,证书所属组织单元
country	String	否	证书 C 项,国家,默认 CN
province	String	否	证书 S 项,证书所属省
city	String	否	证书 L 项,证书所属市
districtCounty	String	否	证书所属区县
givenName	String	否	名字，证书GIVENNAME项
email	String	否	证书所属人邮箱
extraExtension	List<Extension>	否	证书扩展项

Extension 说明：

名称	类型	描述
oid	String	扩展项oid值
value	String	扩展项值
name	String	扩展项名称

证件类型(IdType)说明:

名称	描述
ID	身份证
PASSPORT	护照
MILITARY_ID	军人身份证
BUSINESS_REGISTRATION_CERT	工商登记证
TAX_REGISTRATION_CERT	税务登记证
SHAREHOLDER_CODE_CERT	股东代码证
SOCIAL_SECURITY_CARD	社会保障卡
ARMED_POLICE	武装警察身份证件
HK_MACAU_PASSPORT	港澳居民往来内地通行证
TAIWAN_PASSPORT	台湾居民往来内地通行证
HOUSEHOLD_REGISTER	户口簿
TEMPORARY_ID	临时身份证
POLICE_CERT	警官证
PERMANENT_RESIDENCE_PERMIT	外国人永久居留证
GOVERNMENT_APPROVAL	政府批文
UNIFIED_SOCIAL_CERT	统一社会信用代码证
PRIVATE_NON_ENTERPRISE_CERT	民办非企业登记证书
CORPORATE_CERT	法人证书
OTHER	其他

经办人信息(AgentInfo) 说明：

名称	类型	是否必须	描述
agentName	String	否	经办人姓名
agentId	String	否	经办人身份证号
agentPhone	String	否	经办人手机号码
agentEmail	String	否	经办人邮箱
note	String	否	经办人备注

请求示例：

http://api.ca.demo.smartcert.cn/api
Content-Type: application/x-www-form-urlencoded;charset=utf-8

idType=XXX&...<[业务请求参数]>...&<[公共请求参数]>

三、响应参数

data 结果信息	类型	描述
message	String	业务描述
incorrect	String	业务返回码
signatureCert	String	签名证书
encryptionCert	String	加密证书
encryptionPrivateKey	String	加密私钥
certId	String	证书 ID
extensions	Map<String,String>	扩展项

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "message":"证书签发成功",
    "incorrect": 0,
    "signatureCert": 'RFG...',
    "encryptionCert": 'DCF1...',
    "encryptionPrivateKey": 'DFXSS...',
    "certId": 'SD1...',
    "extensions": '{orderId=dsd24...}'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '证书签发失败，P10校验失败' ,
      "incorrect": 1 ,
      "certId": 'SD1...'

  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	证书签发成功
其它	参考异常代码表

证书签发-企业证书授权日志创建

传入身份信息，获取企业证书授权码。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： enterprise.authorization.logs
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	EnterpriseAuthorizationLogsRequest	是	企业授权日志请求

EnterpriseAuthorizationLogsRequest 说明:

名称	类型	是否必须	描述
idType	IdType	是	证件类型
idNumber	String	是	证件号,需要与证件类型匹配
name	String	是	证书持有者姓名:企业名称
legalName	String	是	法人姓名
announcementReadStartTime	Long	是	CA申请公告阅读开始时间（时间戳格式）
announcementConfirmTime	Long	是	CA申请公告确认时间（时间戳格式）
verificationTime	Long	是	人脸核验时间（时间戳格式）
agreementConfirmTime	Long	是	协议确认时间（时间戳格式）
agentName	String	是	经办人姓名
agentIdCard	String	是	经办人身份证号
agentFaceImage	String	是	经办人人脸图片（base格式）

证件类型(IdType)说明:

名称	描述
ID	身份证
PASSPORT	护照
MILITARY_ID	军人身份证
BUSINESS_REGISTRATION_CERT	工商登记证
TAX_REGISTRATION_CERT	税务登记证
SHAREHOLDER_CODE_CERT	股东代码证
SOCIAL_SECURITY_CARD	社会保障卡
ARMED_POLICE	武装警察身份证件
HK_MACAU_PASSPORT	港澳居民往来内地通行证
TAIWAN_PASSPORT	台湾居民往来内地通行证
HOUSEHOLD_REGISTER	户口簿
TEMPORARY_ID	临时身份证
POLICE_CERT	警官证
PERMANENT_RESIDENCE_PERMIT	外国人永久居留证
GOVERNMENT_APPROVAL	政府批文
UNIFIED_SOCIAL_CERT	统一社会信用代码证
PRIVATE_NON_ENTERPRISE_CERT	民办非企业登记证书
CORPORATE_CERT	法人证书
OTHER	其他

三、响应参数

data 结果信息	类型	描述
message	String	业务描述
incorrect	String	业务返回码
authorizationCode	String	授权码

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "message":"success",
    "incorrect": 0,
    "authorizationCode":'20251208xxx...'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '' ,
      "incorrect": 1
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	获取成功
其它	错误信息

证书签发-企业证书

传入企业信息，进行证书的申请和签发。

一、请求说明

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： issue.enterprise.senior
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	EnterpriseIssueRequest	是	企业证书签发请求

EnterpriseIssueRequest 说明:

名称	类型	是否必须	描述
enterpriseSeniorCertificate	EnterpriseSeniorCertificate	是	企业高级证书实体信息
pkCS10	String	是	用于制作证书的 pkCS10
extensions	Map	否	扩展属性
agentInfo	AgentInfo	否	经办人信息(非合约用户必传经办人手机号)
duration	String	否	证书有效期，格式为数字+字母，字母支持YMDHm，分别对应年月日时分，不传默认1Y。

extensions 说明：

名称	key	value	描述及示例
赠送时间	preTime	赠送时长	数字+字母（Y/M）例: “12Y”12个月，”1Y”1年，赠送时长不得超过一年。

EnterpriseSeniorCertificate (继承自 BaseCertificate) 说明:

名称	类型	是否必须	描述
enterprise	String	否	企业名称
department	String	否	部门名称
idType	IdType	是	证件类型
idNumber	String	是	证件号,需要与证件类型匹配
phoneNumber	String	否	联系号码
ownerName	String	否	证书持有者姓名
authorizationCode	String	否	授权码

BaseCertificate 说明:

名称	类型	是否必须	描述
commonName	String	否	证书 CN 项,证书持有者名称
organization	String	否	证书 O 项,证书所属组织
organizationUnit	String	否	证书 OU 项,证书所属组织单元
country	String	否	证书 C 项,国家,默认 CN
province	String	否	证书 S 项,证书所属省
city	String	否	证书 L 项,证书所属市
districtCounty	String	否	证书所属区县
givenName	String	否	名字，证书GIVENNAME项
email	String	否	证书所属人邮箱
extraExtension	List<Extension>	否	证书扩展项

Extension 说明：

名称	类型	描述
oid	String	扩展项oid值
value	String	扩展项值
name	String	扩展项名称

证件类型(IdType)说明:

名称	描述
ID	身份证
PASSPORT	护照
MILITARY_ID	军人身份证
BUSINESS_REGISTRATION_CERT	工商登记证
TAX_REGISTRATION_CERT	税务登记证
SHAREHOLDER_CODE_CERT	股东代码证
SOCIAL_SECURITY_CARD	社会保障卡
ARMED_POLICE	武装警察身份证件
HK_MACAU_PASSPORT	港澳居民往来内地通行证
TAIWAN_PASSPORT	台湾居民往来内地通行证
HOUSEHOLD_REGISTER	户口簿
TEMPORARY_ID	临时身份证
POLICE_CERT	警官证
PERMANENT_RESIDENCE_PERMIT	外国人永久居留证
GOVERNMENT_APPROVAL	政府批文
UNIFIED_SOCIAL_CERT	统一社会信用代码证
PRIVATE_NON_ENTERPRISE_CERT	民办非企业登记证书
CORPORATE_CERT	法人证书
OTHER	其他

经办人信息(AgentInfo) 说明：

名称	类型	是否必须	描述
agentName	String	否	经办人姓名
agentId	String	否	经办人身份证号
agentPhone	String	否	经办人手机号码
agentEmail	String	否	经办人邮箱
note	String	否	经办人备注

请求示例：

http://api.ca.demo.smartcert.cn/api
Content-Type: application/x-www-form-urlencoded;charset=utf-8

idType=XXX&...<[业务请求参数]>...&<[公共请求参数]>

三、响应参数

data 结果信息	类型	描述
message	String	业务描述
incorrect	String	业务返回码
signatureCert	String	签名证书
encryptionCert	String	加密证书
encryptionPrivateKey	String	加密私钥
certId	String	证书 ID
extensions	Map<String,String>	扩展项

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "message":"证书签发成功",
    "incorrect": 0,
    "signatureCert": 'DCF1...',
    "encryptionCert": '1WD...',
    "encryptionPrivateKey": 'FFGG...',
    "certId": 'SD1...',
    "extensions": '{orderId=dsd24...}'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '证书签发失败,...' ,
      "incorrect": 1 ,
      "certId": 'SD1...'
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	证书签发成功
其它	参考异常代码表

证书注销

输入证书标识，注销证书。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： revoke
请求方式：POST 或 GET

二、请求参数

名称	类型	是否必须	描述
request	RevokeRequest	是	证书注销请求

RevokeRequest 说明

名称	类型	是否必须	描述
certId	String	是	证书唯一标识
extensions	Map	否	扩展属性

请求示例：

http或https://222.190.151.234:2016/api?

&certId=XXX

&<[公共请求参数]>

三、响应参数

业务响应名称	类型	描述
incorrect	String	结果响应码
message	String	注销说明
certId	String	证书 ID
result	Boolean	注销结果
extensions	Map<String,String>	扩展项

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '注销成功' ,
      "certId": 'sd34df...' ,
      "result": 'true' ,
      "incorrect": 0,
      "extensions": '{orderId=dsd24...}'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
       "message": '注销失败，证书非可用状态' ,
       "incorrect": 1 ,
       "result": 'false',
       "certId": 'sd34df...'
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	证书注销成功
其它	参考异常代码表

证书延期

输入证书标识和需要延期的天数，对该证书进行延期。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api

服务接口名称(即公共参数 method 的值)： postpone
请求方式：POST 或 GET

二、请求参数

名称	类型	是否必须	描述
request	PostponeRequest	是	证书延期请求

PostponeRequest 说明:

名称	类型	是否必须	描述
certId	String	是	证书唯一标识
pkCS10	String	否	用于制作证书的 pkCS10
duration	String	否	证书延期时间，格式为数字+字母，字母支持YMDHm，分别对应年月日时分，不传默认1Y。
userOldKey	Boolean	否	是否使用原密钥对，默认为 True(此选项针对加密证书密钥对)
extensions	Map	否	扩展属性

请求示例：

http或https://222.190.151.234:2016/api?

&certId=XXX

&duration=2M

&<[公共请求参数]>

三、响应参数

data 结果信息	类型	描述
signatureCert	String	签名证书
encryptionCert	String	加密证书
encryptionPrivateKey	String	加密私钥
certId	String	证书 ID
message	String	业务响应描述
incorrect	String	业务返回码
extensions	Map<String,String>	扩展项

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '延期成功' ,
      "incorrect": 0 ,
      "signatureCert": 'ECS24S...',
      "encryptionCert": 'ECS24S...',
      "encryptionPrivateKey": 'ECS24S...',
      "certId": 'ECS24S...',
      "extensions": '{orderId=dsd24...}'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '延期失败，延期天数超过5年.' ,
      "incorrect": 1 ,
      "certId": 'ECS24S...'
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	延期成功
其它	参考异常代码表

证书重发

传入证书标识和介质 P10，对相应证书做重发。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： reissue
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	ReissueRequest	是	证书重发请求

ReissueRequest 说明

名称	类型	是否必须	描述
certId	String	是	证书 id
pkCS10	String	否	用于制作证书的 pkCS10 (建议使用)
userOldKey	Boolean	否	是否使用原密钥对，默认为 True(此选项针对加密证书密钥对)
extensions	Map	否	扩展属性

请求示例：

http://api.ca.demo.smartcert.cn/api
Content-Type: application/x-www-form-urlencoded;charset=utf-8

certId=XXX&pkCS10=XXX&<[公共请求参数]>

三、响应参数

data 结果信息	类型	描述
message	String	描述
incorrect	String	返回码
signatureCert	String	签名证书
encryptionCert	String	加密证书
encryptionPrivateKey	String	加密私钥
certId	String	证书 ID
extensions	Map<String,String>	扩展项

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "message":"证书重发成功",
    "incorrect": 0,
    "signatureCert": 'DCF1...',
    "encryptionCert": 'DCF1...',
    "encryptionPrivateKey": 'ECS24S...',
    "certId": 'SD1...',
    "extensions": '{orderId=dsd24...}'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '证书重发失败，该证书已被注销' ,
      "incorrect": 1 ,
      "certId": 'SD1...'
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	证书重发成功
其它	参考异常代码表

证书密钥恢复

传入证书标识和介质 P10，对相应证书进行密钥恢复。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： recover
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	RecoverRequest	是	证书密钥恢复请求

ReissueRequest 说明

名称	类型	是否必须	描述
certId	String	是	证书 id
pkCS10	String	是	用于制作证书的 pkCS10
extensions	Map	否	扩展属性

请求示例：

http://api.ca.demo.smartcert.cn/api
Content-Type: application/x-www-form-urlencoded;charset=utf-8

certId=XXX&pkCS10=XXX&<[公共请求参数]>

三、响应参数

data 结果信息	类型	描述
message	String	描述
incorrect	String	返回码
encryptionCert	String	加密证书
encryptionPrivateKey	String	加密私钥
signatureCert	String	签名证书
certId	String	证书 ID
extensions	Map<String,String>	扩展项

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "message":"success",
    "incorrect": 0,
    "encryptionCert": 'DCF1...',
    "encryptionPrivateKey": 'ECS24S...',
    "certId": 'SD1...',
    "extensions": '{orderId=dsd24...}'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
      "message": '证书密钥恢复失败，该证书已被注销' ,
      "incorrect": 1 ,
      "certId": 'SD1...'
  },
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	证书密钥恢复成功
其它	参考异常代码表

根据id查询证书

传入证书id,精确查询证书。

一、公共参数

请求地址：http://api.ca.demo.smartcert.cn/api，http://api.ca.demo.smartcert.cn/api
服务接口名称(即公共参数 method 的值)： query.by.id
请求方式：POST

二、请求参数(请求方式为 post)

请求参数以表单形式提交,Content-Type 值为: application/x-www-form-urlencoded;charset=utf-8

名称	类型	是否必须	描述
request	CertQueryByIdRequest	是	根据证书id查询证书请求

CertQueryByIdRequest 说明:

名称	类型	是否必须	描述
certId	String	是	待查询证书的标识

请求示例：

http://api.ca.demo.smartcert.cn/api
Content-Type: application/x-www-form-urlencoded;charset=utf-8
cerId=XXX&...<[业务请求参数]>...&<[公共请求参数]>

三、响应参数

data 结果信息	类型	描述
certJson	String	证书对象json 格式

四、成功示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": {
    "idType": 'ID...',
    "idNumber": '32012...',
    "phoneNumber": '173111...',
    "ownerName": 'liubei...',
    "certificateType": 'ENTERPRISE_SENIOR',
    "enterprise": 'XX...',
    "department":'XX',
    "subject": 'CN=XX,OU=XX,O=XX,ST=XX,L=XX,C=CN',
    "id": 'api_ca_e...',
    "commonName": 'XX...',
    "organization": 'XX...',
    "organizationUnit": 'XX...',
    "country": 'XX...',
    "province": 'XX...',
    "city": 'XX...',
    "districtCounty": 'XX...',
    "notBefore": 'Mon Oct 01 22:36:01 CST 2018',
    "notAfter": 'Thu Oct 01 22:36:01 CST 2020',
    "email": 'zhugeliang@han.cn'
  },
  "message": "success"
}

五、失败示例

JSON示例

{
  "code": 0,
  "requestId": "dsd24...",
  "data": null,
  "message": "success"
}

六、返回码说明(incorrect)

返回码	描述
0	证书查询成功
其它	参考异常代码表