证书开放API文档

版本	更新内容	更新时间	修订人
1.4	支持工作流流程定义、流程实例及自定义节点管理接口	2026.5.25	黄辉
1.3	支持证书立即检测域名DCV配置、检测DCV是否配置正确、修改DCV方式	2025.7.15	黄辉
1.2	支持证书重颁发、追加域名、购买域名额度等	2025.6.20	张彬雷
1.1	申请时取消赠送域名标记(skipForceGivenDomain)	2025.4.25	张彬雷
1.0	api文档基础版	2025.3.15	张彬雷

证书状态回调配置说明

1.配置回调地址及secretKey

向新网渠道申请配置回调地址。注：对接方接收回调时必须以post方式接收

2.回调参数说明

参数名	位置	类型	必选	说明
secretKey	header	string	是	私钥 (新网提供)
serviceCode	body	string	是	服务编号
sslStatus	body	string	是	证书状态
description	body	string	是	证书状态描述
outCertId	body	string	是	证书实例ID
applyTime	body	string	是	证书申请时间 yyyy-MM-dd HH:mm:ss
serviceStartTime	body	string	是	订阅服务有效期开始时间 yyyy-MM-dd HH:mm:ss
serviceEndTime	body	string	是	订阅服务有效期结束时间 yyyy-MM-dd HH:mm:ss
certStartTime	body	string	是	证书有效期开始时间 yyyy-MM-dd HH:mm:ss
certEndTime	body	string	是	证书有效期结束时间 yyyy-MM-dd HH:mm:ss
certRemainDays	body	int	是	证书有效期剩余天数

回调返回值要求返回值中包含status=true则认为回调成功例如：

{
   "status":true,
   "code":200
}

{
   "status":false,
   "code":200,
   "errorMsg":"状态不匹配"
}

证书状态说明

状态	描述
unstart	待申请
renew_unstart	待申请
created	待审核
approvaling	审核中
cancel_approvaling	申请取消中
canceled	申请已取消
verifing_timeout	CA验证超时(只针对DV类型证书)
domain_verifing	待验证
issued	已签发
rejected	审核失败
need_renew	即将到期
expire	已过期
renewed	已续签
refunded	已退单

注意事项：

1.只有DV类型证书不需要上传确认函，其他类型证书都需要上传确认函。

2.获取DCV解析值只有在待审核、待验证、已签发三个状态时才能获取。

3.申请证书提交后，假如是申请的DV类型证书，状态会很快由待审核变成待验证；假如是OV或者EV类型则需要上传确认函审核通过了才能变成待验证。

4.申请证书时填写的域名一定要严格按照购买商品的类型填写，假如购买的是单域名证书，填写的域名一定是单个域名，不要填写泛域名，否则会导致申请失败；假如购买的是通配符类型证书，填写域名时一定要以*.开头，否则会导致申请失败。

API列表

POST 证书商品规格列表

POST /ssl/v1/trade/getGoodsList

### 请求参数 - POST 证书商品规格列表

| 名称            | 位置   | 类型     | 必选 | 说明                                                        |
|---------------|------|--------|----|-----------------------------------------------------------|
| 无  | -  | -  | 否  | （依然需要按规范传递标准参数，如时间戳authTimestamp） |

{
      "status": true,
      "code": "200",
      "res": [
    {
          "goodsCode": "xxxxxx",
          "goodsName": "ssl单域名证书",
          "buyTimeList": "1Y,2Y,3Y,4Y,5Y,6Y,7Y,8Y,9Y",
          "allowAutoRenew": true,
          "subGoodsCode": "xxxxxxx",
          "maxDomainQuota": 5,
          "freeDomainQuota": 3
      }
  ]
}

返回结果 - POST 证书商品规格列表

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 证书商品规格列表

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[array]	true	none	返回参数
»» goodsCode	string	false	none	证书商品编号
»» goodsName	string	false	none	证书商品名称
»» buyTimeList	string	false	none	购买时长列表，时长由数字和单位(Y-年，M-月，D-日)构成，多时长逗号分隔
»» allowAutoRenew	string	false	none	是否允许自动续费，true-允许，false-不允许
»» subGoodsCode	string	false	none	域名配额商品编号，值为null表示该证书不可购买域名配额
»» maxDomainQuota	string	false	none	域名配额最大可购买数量，当subGoodsCode为null时，值为null
»» freeDomainQuota	string	false	none	附赠的免费域名配额数量

POST 购买证书

POST /ssl/v1/trade/buy

{
  "goodsCode": "65248745158774",
  "buyAmount": 1,
  "buyUnit": "Y",
  "buyNum": 1,
  "subGoodsCode": null,
  "subGoodsNum": 0,
  "autoRenew": false
}

请求参数 - POST 购买证书

名称	位置	类型	必选	说明
» goodsCode	body	string	是	证书商品编号
» buyAmount	body	integer	是	购买时长，最小为1
» buyUnit	body	string	是	时长单位，Y-年 M-月 D-日
» buyNum	body	integer	是	购买数量，最小为1
» subGoodsCode	body	string	否	域名配额商品编号，不购买域名配额时为null
» subGoodsNum	body	integer	否	域名配额购买数量，不购买域名配额时值为null，注意此数量包含附赠的免费域名配额数量。示例：如果免费配额数量为2，当此值为3时，表示需要付费的域名配额数量为1。
» autoRenew	body	boolean	否	是否自动续费：true-是,false-否，默认false

{
  "status": true,
  "code": "200",
  "msg": "",
  "res": "507cac5cf9c54c72bd3e1971a83e3eef"
}

返回结果 - POST 购买证书

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 购买证书

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	string	true	none	服务编号

POST 续费证书

POST /ssl/v1/trade/renew

{
  "serviceCode": "string",
  "buyAmount": 0,
  "buyUnit": "string"
}

请求参数 - POST 续费证书

名称	位置	类型	必选	说明
» serviceCode	body	string	是	证书服务编号
» buyAmount	body	integer	是	续费时长，最小为1
» buyUnit	body	string	是	时长单位，Y-年 M-月 D-日

{
  "status": true,
  "code": "200"
}

返回结果 - POST 续费证书

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 续费证书

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	string	true	none		返回code 200成功 400失败

POST 添加组织

POST /ssl/v1/org/addOrg

{
  "name": "string",
  "telephone": "string",
  "addressLine1": "string",
  "city": "string",
  "state": "string",
  "zipCode": "string",
  "department": "string",
  "orgType": "PO",
  "orgNumber": "string"
}

请求参数 - POST 添加组织

名称	位置	类型	必选	说明
» name	body	string	是	名称
» telephone	body	string	是	电话
» addressLine1	body	string	是	地址

» city	body	string	是	城市（直辖市时，直接是直辖市名称，如：北京市）
» state	body	string	是	地区（直辖市时，直接是直辖市名称，如：北京市）
» zipCode	body	string	是	邮编
» department	body	string	否	部门 <= 50 字符
» orgType	body	string	否	类型：PO-私营个体,BE-商业企业,GE-政府实体,NC-非营利组织,PI-事业单位（cfca类型证书需要传）
» orgNumber	body	string	否	组织机构代码（cfca类型证书需要传）

{
  "status": true,
  "code": "200",
  "msg": "",
  "res": "abcdderdsdfgggla"
}

返回结果 - POST 添加组织

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 添加组织

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	string	true	none	组织编号

POST 获取组织

POST /ssl/v1/org/getOrg

{
  "orgCode": "string"
}

请求参数 - POST 获取组织

名称	位置	类型	必选	说明
» orgCode	body	string	是	组织编号

{
  "status": true,
  "code": "200",
  "res": [
    {
      "orgCode": "",
      "agentCode": "",
      "name": "",
      "telephone": "",
      "addressLine1": "",
      "city": "",
      "state": "",
      "country": "",
      "zipCode": "",
      "department": "",
      "orgType": "",
      "orgNumber": ""
    }
  ]
}

返回结果 - POST 获取组织

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取组织

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	object	true	none	none
»» orgCode	string	true	none	组织code，唯一标识
»» name	string	true	none	名称
»» telephone	integer	true	none	电话
»» addressLine1	integer	true	none	地址
»» city	integer	true	none	城市
»» state	integer	true	none	地区
»» country	integer	true	none	国家
»» zipCode	integer	true	none	邮编
»» department	integer	true	none	部门
»» orgType	integer	true	none	类型：PO-私营个体,BE-商业企业,GE-政府实体,NC-非营利组织,PI-事业单位
»» orgNumber	integer	true	none	组织机构代码

POST 修改组织

POST /ssl/v1/org/modifyOrg

{
  "orgCode": "string",
  "name": "string",
  "telephone": "string",
  "addressLine1": "string",
  "city": "string",
  "state": "string",
  "zipCode": "string",
  "department": "string",
  "orgType": "PO",
  "orgNumber": "string"
}

请求参数 - POST 修改组织

名称	位置	类型	必选	说明
» orgCode	body	string	是	组织code，唯一标识
» name	body	string	是	名称
» telephone	body	string	是	电话
» addressLine1	body	string	是	地址
» city	body	string	是	城市（直辖市时，直接是直辖市名称，如：北京市）
» state	body	string	是	地区（直辖市时，直接是直辖市名称，如：北京市）
» zipCode	body	string	是	邮编
» department	body	string	否	部门
» orgType	body	string	否	类型：PO-私营个体,BE-商业企业,GE-政府实体,NC-非营利组织,PI-事业单位（cfca类型证书需要传）
» orgNumber	body	string	否	组织机构代码（cfca类型证书需要传）

{
  "status": true,
  "code": "200"
}

返回结果 - POST 修改组织

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 修改组织

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	string	true	none		返回code 200成功 400失败

POST 删除组织

POST /ssl/v1/org/deleteOrg

{
  "orgCode": "string"
}

请求参数 - POST 删除组织

名称	位置	类型	必选	说明
» orgCode	body	string	是	组织code，唯一标识

{
  "status": true,
  "code": "200"
}

返回结果 - POST 删除组织

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 删除组织

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	string	true	none		返回code 200成功 400失败

POST 添加联系人

POST /ssl/v1/org/addOrgContact

{
  "firstName": "string",
  "lastName": "string",
  "jobTitle": "string",
  "telephone": "string",
  "email": "string",
  "idType": "SFZ",
  "idNumber": "string"
}

请求参数 - POST 添加联系人

名称	位置	类型	必选	说明
» firstName	body	string	是	姓名
» lastName	body	string	是	姓
» jobTitle	body	string	是	职位 <= 40 字符
» telephone	body	string	是	电话
» email	body	string	是	邮箱
» idType	body	string	否	证件类型：SFZ-身份证,HZ-护照（cfca类型证书需要传）
» idNumber	body	string	否	证件号码（cfca类型证书需要传）

{
  "status": true,
  "code": "200",
  "res": "ancdeffasdfasdfll"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 添加联系人

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 添加联系人

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» res	string	true	none	联系人编号

POST 获取联系人

POST /ssl/v1/org/getOrgContact

{
  "contactCode": "string"
}

请求参数 - POST 获取联系人

名称	位置	类型	必选	说明
» contactCode	body	string	是	联系人编号

{
  "status": true,
  "code": "200",
  "res": {
    "contactCode": "string",
    "firstName": "string",
    "lastName": "string",
    "jobTitle": "string",
    "telephone": "string",
    "email": "string",
    "idType": "SFZ",
    "idNumber": "string"
  }
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 获取联系人

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取联系人

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	联系人信息
»» contactCode	string	true	none	联系人编号
»» firstName	string	true	none	姓
»» lastName	string	true	none	名
»» jobTitle	string	true	none	职位
»» telephone	string	true	none	电话
»» email	string	true	none	邮件
»» idType	string	false	none	证件类型：SFZ-身份证,HZ-护照
»» idNumber	string	false	none	证件号码

POST 修改联系人

POST /ssl/v1/org/modifyOrgContact

{
  "contactCode": "string",
  "firstName": "string",
  "lastName": "string",
  "jobTitle": "string",
  "telephone": "string",
  "email": "string",
  "idType": "SFZ",
  "idNumber": "string"
}

请求参数 - POST 修改联系人

名称	位置	类型	必选	说明
» contactCode	body	string	是	联系人编号
» firstName	body	string	是	姓名
» lastName	body	string	是	姓
» jobTitle	body	string	是	职位
» telephone	body	string	是	电话
» email	body	string	是	邮箱
» idType	body	string	否	证件类型：SFZ-身份证,HZ-护照（cfca类型证书需要传）
» idNumber	body	string	否	证件号码（cfca类型证书需要传）

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 修改联系人

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 修改联系人

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 删除联系人

POST /ssl/v1/org/deleteOrgContact

{
  "contactCode": "string"
}

请求参数 - POST 删除联系人

名称	位置	类型	必选	说明
» contactCode	body	string	是	联系人编号

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 删除联系人

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 删除联系人

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		接口请求是否成功 true成功、false失败
» code	string	true	none		code 200 正常

POST 查询证书服务列表

POST /ssl/v1/order/query

{
  "serviceCode": "string",
  "brand": "XINNET",
  "sslStatus": "unstart",
  "certType": "E",
  "remark": "string",
  "domainName": "string"
}

请求参数 - POST 查询证书服务列表

名称	位置	类型	必选	说明
» serviceCode	body	string	否	服务编号
» brand	body	string	否	品牌枚举值:XINNET 、XINNETBRAND 、Digicert 、Xinnet 、CFCA、 GeoTrust 、GlobalSign 、SHECA
» sslStatus	body	string	否	证书状态枚举值：unstart、renew_unstart、created、approvaling、cancel_approvaling、canceled、domain_verifing、issued、rejected、need_renew、expire、renewed、refunded ，状态说明参考上方的证书状态表
» certType	body	string	否	证书类型E=企业，P=个人
» remark	body	string	否	备注
» domainName	body	string	否	域名

{
  "status": true,
  "code": "200",
  "res": [
    {
      "serviceCode": "25ef2124f4d44cf6bdca891e443bb41a",
      "sslName": "xinnet_ssl_dv",
      "goodsCode": "34618915647399",
      "goodsName": "Xinnet域名型SSL证书",
      "validityMonths": 12,
      "timeAmount": 2,
      "timeUnit": "Y",
      "sslStatus": "canceled",
      "domainName": "niujf.top",
      "dnsNames": "",
      "buyTime": "2025-02-17 17:13:52",
      "applyTime": "2025-02-20 09:43:12",
      "startTime": "2025-02-20 10:43:12",
      "endTime": "2026-02-20 10:43:12",
      "algorithm": "RSA",
      "strength": "SHA256",
      "keyStrength": 2048,
      "authMethods": "cname",
      "orgCode": "98cd386ee67841c18c66f7be0f359ceb",
      "contactCode": "98cd386ee67841c18c66f7be0f359ceb"
    }
  ]
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 查询证书服务列表

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 查询证书服务列表

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	[array]	true	none	证书集合
»» serviceCode	string	true	none	服务编号
»» sslName	string	true	none	证书名称
»» goodsCode	string	true	none	商品编号
»» goodsName	string	true	none	商品名称
»» validityMonths	integer	true	none	证书有效期(月)
»» timeAmount	integer	true	none	购买时长
»» timeUnit	string	true	none	购买时间单位（M.Y.C）
»» sslStatus	string	true	none	证书状态
»» domainName	string	true	none	域名
»» dnsNames	string	true	none	备用域名，多域名逗号分隔
»» buyTime	string	true	none	购买时间
»» applyTime	string	true	none	申请时间
»» serviceStartTime	string	true	none	订阅服务有效期开始时间 yyyy-MM-dd HH:mm:ss
»» serviceEndTime	string	true	none	订阅服务有效期结束时间 yyyy-MM-dd HH:mm:ss
»» startTime	string	true	none	证书有效期开始时间
»» endTime	string	true	none	证书有效期结束时间
»» algorithm	string	true	none	加密算法
»» strength	string	true	none	加密摘要
»» keyStrength	integer	true	none	秘钥强度
»» authMethods	string	true	none	认证方式
»» orgCode	string	true	none	组织编号
»» contactCode	string	true	none	联系人编号

POST 申请证书

POST /ssl/v1/order/apply

{
  "serviceCode": "string",
  "algorithm": "RSA",
  "strength": "SHA256",
  "keyStrengthStr": "string",
  "authMethods": "string",
  "domainName": "string",
  "dnsNames": "string",
  "orgCode": "string",
  "contactCode": "string"
}

请求参数 - POST 申请证书

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号
» algorithm	body	string	是	加密算法枚举值: RSA/SM2/ECDSA
» strength	body	string	是	签名算法 SHA256/SHA384/SHA512/SM3
» keyStrengthStr	body	string	是	秘钥强度 RSA: 2048, 4096, 8192; ECDSA: 224, prime256v1, 384; SM2: sm2p256v1
» authMethods	body	string	是	认证方式 DNS, FILE, CNAME, TXT, EMAIL
» domainName	body	string	是	域名
» dnsNames	body	string	否	备用域名，多域名逗号分隔
» orgCode	body	string	是	组织编号
» contactCode	body	string	是	联系人编号
» skipForceGivenDomain	body	boolean	否	取消赠送域名www，默认true.当申请域名为主域名时，默认是不赠送www域名，如需要赠送www则需要此参数传false.

注意：在申请时需要谨慎，购买的证书如果是通配符证书时，申请的域名必须以*.开头

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 申请证书

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 申请证书

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		接口请求是否成功 true成功、false失败
» code	string	true	none		code 200 正常

POST 续签证书

POST /ssl/v1/order/renew

{
  "serviceCode": "string"
}

请求参数 - POST 续签证书

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 续签证书

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 续签证书

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		接口请求是否成功 true成功、false失败
» code	string	true	none		code 200 正常

POST 取消订单

POST /ssl/v1/order/cancel

{
  "serviceCode": "string"
}

请求参数 - POST 取消订单

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 取消订单

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 取消订单

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		接口请求是否成功 true成功、false失败
» code	string	true	none		code 200 正常

POST 获取证书数据

POST /ssl/v1/order/getPem

{
  "serviceCode": "string"
}

请求参数 - POST 获取证书数据

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {
    "key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----\n",
    "pem": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----\n",
    "icaPem": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----\n"
  }
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 获取证书数据

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取证书数据

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	证书数据对象
»» key	string	true	none	私钥
»» pem	string	true	none	证书
»» icaPem	string	true	none	中间证书

POST 获取DCV解析信息

POST /ssl/v1/order/dcvInfo

{
  "serviceCode": "string"
}

请求参数 - POST 获取DCV解析信息

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": [
    {
      "authDomain": "testxinnet333.cn",
      "domain": "testxinnet333.cn",
      "authPath": "_dnsauth",
      "authVal": "202502090336320rd14uq7braz40k7h0237e7kzb2317brvgfnotd565lyv94d89",
      "authMethod": "TXT",
      "authState": "待验证"
    }
  ]
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 获取DCV解析信息

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取DCV解析信息

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	[array]	true	none	解析集合
»» authDomain	string	true	none	验证域名
»» domain	string	true	none	域名
»» authPath	string	true	none	验证路径
»» authVal	string	true	none	验证值
»» authMethod	string	true	none	验证方式
»» authState	string	true	none	验证状态验证完成/待验证

POST 下载证书

POST /ssl/v1/order/downloadZip

{
  "serviceCode": "1702452601870"
}

请求参数 - POST 下载证书

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAAVAAAAVG9tY2F0OF81Ky90b21"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 下载证书

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 下载证书

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	string	true	none	base64编码的字节流，获取后请使用base64解码

POST 通知CA机构加急审核

POST /ssl/v1/order/dcvImmediatelyDetection

{
  "serviceCode": "1702452601870"
}

请求参数 - POST 通知CA机构加急审核

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 通知CA机构加急审核

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 通知CA机构加急审核

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 检测DCV是否配置正确

POST /ssl/v1/order/dcvInfoCheck

{
  "serviceCode": "1702452601870"
}

请求参数 - POST 检测DCV是否配置正确

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": [
    {
      "authDomain": "testxinnet333.cn",
      "domain": "testxinnet333.cn",
      "authPath": "_dnsauth",
      "authVal": "202502090336320rd14uq7braz40k7h0237e7kzb2317brvgfnotd565lyv94d89",
      "authMethod": "TXT",
      "authState": "待验证"
    }
  ]
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 检测DCV是否配置正确

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 检测DCV是否配置正确

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	[array]	true	none	解析集合
»» authDomain	string	true	none	验证域名
»» domain	string	true	none	域名
»» authPath	string	true	none	验证路径
»» authVal	string	true	none	验证值
»» authValChecked	string	true	none	验证结果
»» authMethod	string	true	none	验证方式 DNS, FILE, CNAME, TXT, EMAIL
»» authState	string	true	none	验证状态成功ok 失败fail

POST 修改DCV方式

POST /ssl/v1/order/dcvMethodChange

{
  "serviceCode": "1702452601870",
  "type": "CNAME"
}

请求参数 - POST 修改DCV方式

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号
» type	body	string	是	验证方式 DNS, FILE, CNAME, TXT, EMAIL

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 修改DCV方式

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 修改DCV方式

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 获取上传确认函文件accessToken

POST /ssl/v1/order/getAccessToken

{
  "serviceCode": "string"
}

请求参数 - POST 获取上传确认函文件accessToken

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {
    "accessToken": "",
    "uploadAuditFileUrl": "https://test-ssl.xinnet.com/xinnet_ssl/service/uploadAuditFile"
  }
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 获取上传确认函文件accessToken

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取上传确认函文件accessToken

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	对象
»» accessToken	string	true	none	token
»» uploadAuditFileUrl	string	true	none	确认函上传地址

POST 上传证书申请资料

POST 请阅读下面的注意事项注意：请求地址请使用获取accessToken时，返回的uploadAuditFileUrl对应值作为上传的地址。

请求参数 - POST 上传证书申请资料

名称	位置	类型	必选	说明
» accessToken	query	string	是	访问 token，用于身份验证
» type	query	string	是	上传文件类型 ,枚举: OrgConfirmLetter("组织信息确认函")、Authorization("授权书")、ApplyForm("申请表")、OrgCode("组织机构代码")、Email("企业邮箱")、IdCard("身份证")
» file	body	multipart/form-data	是	确认函

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果 - POST 上传证书申请资料

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 上传证书申请资料

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		接口请求是否成功 true成功、false失败
» code	string	true	none		code 200 正常

重颁发证书初始化

POST /ssl/v1/order/reissueInit

{
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194"
}

请求参数 - 重颁发证书初始化

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {
    "service": {
      "serviceCode": "25ef2124f4d44cf6bdca891e443bb41a",
      "sslName": "xinnet_ssl_dv",
      "goodsCode": "34618915647399",
      "goodsName": "Xinnet域名型SSL证书",
      "validityMonths": 12,
      "timeAmount": 2,
      "timeUnit": "Y",
      "sslStatus": "issued",
      "domainName": "niujf.top",
      "dnsNames": "",
      "buyTime": "2025-02-17 17:13:52",
      "applyTime": "2025-02-20 09:43:12",
      "startTime": "2025-01-09 00:00:00",
      "endTime": "2026-01-09 23:59:59",
      "algorithm": "RSA",
      "strength": "SHA256",
      "keyStrength": 2048,
      "authMethods": "cname",
      "orgCode": "98cd386ee67841c18c66f7be0f359ceb",
      "contactCode": "98cd386ee67841c18c66f7be0f359ceb"
    },
    "revokeTips": "吊销提示ccc",
    "reissueTips": "重颁发提示aaa"
  }
}

{
  "status": false,
  "code": "400",
  "msg": "服务不存在"
}

返回结果 - 重颁发证书初始化

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 重颁发证书初始化

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	返回结果
»» revokeTips	string	true	none	吊销提示语
»» reissueTips	string	true	none	重颁发提示语
»» service	object	true	none	服务信息
»»» serviceCode	string	true	none	服务编号
»»» sslName	string	true	none	证书名称
»»» goodsCode	string	true	none	商品编号
»»» goodsName	string	true	none	商品名称
»»» validityMonths	integer	true	none	证书有效期(月)
»»» timeAmount	integer	true	none	购买时长
»»» timeUnit	string	true	none	购买时间单位（M.Y.C）
»»» sslStatus	string	true	none	证书状态
»»» domainName	string	true	none	域名
»»» dnsNames	string	true	none	备用域名，多域名逗号分隔
»»» buyTime	string	true	none	购买时间
»»» applyTime	string	true	none	申请时间
»»» algorithm	string	true	none	加密算法
»»» strength	string	true	none	加密摘要
»»» keyStrength	integer	true	none	秘钥强度
»»» authMethods	string	true	none	认证方式
»»» orgCode	string	true	none	组织编号
»»» contactCode	string	true	none	联系人编号

重颁发证书

POST /ssl/v1/order/reissue

注意：

在重颁发时需要谨慎，购买的证书如果是多域名证书时，重颁发的域名必须以*.开头
支持重颁发条件：证书状态为已签发(issued)、即将到期(need_renew)或者DV证书的状态为CA验证超时(verifing_timeout)

{
  "algorithm": "RSA",
  "authMethods": "dns",
  "dnsNames": "",
  "domainName": "test.xinnet.com",
  "keyStrengthStr": "2048",
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194",
  "strength": "SHA256",
  "skipForceGivenDomain ": false
}

请求参数 - 重颁发证书

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号
» algorithm	body	string	是	加密算法枚举值: RSA/SM2/ECDSA
» keyStrengthStr	body	string	是	秘钥强度 RSA: 2048, 4096, 8192; ECDSA: 224, 256, 384; SM2: 256
» authMethods	body	string	是	认证方式 DNS, FILE, CNAME, TXT, EMAIL
» domainName	body	string	是	域名
» dnsNames	body	string	否	备用域名，多域名逗号分隔
» skipForceGivenDomain	body	boolean	否	取消赠送域名www，默认true.当申请域名为主域名时，默认是不赠送www域名，如需要赠送www则需要此参数传false.

{
  "status": true,
  "code": "200",
  "res": {}
}

{
  "status": false,
  "code": "400",
  "msg": "不支持重颁发"
}

返回结果 - 重颁发证书

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 重颁发证书

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

取消重颁发

POST /ssl/v1/order/cancelReissue

注意：只有在证书重颁发中，证书状态是待审核(created)、审核中(approvaling)、待验证(domain_verifing)时才支持取消重颁发

{
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194"
}

请求参数 - 取消重颁发

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {}
}

{
  "status": false,
  "code": "400",
  "msg": "服务不存在"
}

返回结果 - 取消重颁发

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 取消重颁发

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

获取证书域名总额度

POST /ssl/v1/order/getDomainQuota

{
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194"
}

请求参数 - 获取证书域名总额度

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {
    "result": 7
  }
}

{
  "status": false,
  "code": "400",
  "msg": "服务不存在"
}

返回结果 - 获取证书域名总额度

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 获取证书域名总额度

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	返回结果
»» result	number	true	none	域名总额度

证书域名购买额度初始化

POST /ssl/v1/order/appendDomainQuotaInit

注: 购买额度时，服务时长会与当前证书剩余可签发年限对齐

{
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194"
}

请求参数 - 证书域名购买额度初始化

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {
    "appendMaxQuota": 93,
    "goodsPrice": {
      "goodsCode": "22858393460797",
      "price": 0.03,
      "timeAmount": "3",
      "timeUnit": "Y"
    },
    "appendMinQuota": 2,
    "buyDomainNameTips": ""
  }
}

{
  "status": false,
  "code": "400",
  "msg": "服务不存在"
}

返回结果 - 证书域名购买额度初始化

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 证书域名购买额度初始化

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	返回结果
»» appendMaxQuota	number	true	none	购买额度上限
»» appendMinQuota	number	true	none	购买额度下限
»» buyDomainNameTips	string	true	none	购买额度提示
»» goodsPrice	object	true	none	购买额度价格
»»» goodsCode	string	true	none	购买额度价格商品Code
»»» price	number	true	none	购买额度价格
»»» timeAmount	string	true	none	购买额度时长
»»» timeUnit	string	true	none	购买额度时长单位

证书域名购买额度

POST /ssl/v1/trade/appendDomainQuotaBuyNow

注: 购买额度时，服务时长会与当前证书剩余可签发年限对齐

{
  "buyAmount": 7,
  "buyUnit": "Y",
  "serviceCode": "1e7c30bee7054f72b5f5b9c21d8185ca",
  "subGoodsCode": "22858393460797",
  "subGoodsNum": 20
}

请求参数 - 证书域名购买额度

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号
» subGoodsCode	body	string	是	域名额度商品编码, 此处从证书域名购买额度初始化接口中取值
» subGoodsNum	body	number	是	购买额度数
» buyAmount	body	number	是	购买额度时长,此处从证书域名购买额度初始化接口中取值
» buyUnit	body	string	是	购买额度时长单位,此处从证书域名购买额度初始化接口中取值

{
  "status": true,
  "code": "200",
  "res": {}
}

{
  "status": false,
  "code": "400",
  "msg": "服务不存在"
}

返回结果 - 证书域名购买额度

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 证书域名购买额度

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	返回结果

证书追加域名初始化

POST /ssl/v1/order/appendDomainInit

注: 购买额度时，服务时长会与当前证书剩余可签发年限对齐

{
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194"
}

请求参数 - 证书追加域名初始化

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号

{
  "status": true,
  "code": "200",
  "res": {
    "service": {
      "serviceCode": "25ef2124f4d44cf6bdca891e443bb41a",
      "sslName": "xinnet_ssl_dv",
      "goodsCode": "34618915647399",
      "goodsName": "Xinnet域名型SSL证书",
      "validityMonths": 12,
      "timeAmount": 2,
      "timeUnit": "Y",
      "sslStatus": "issued",
      "domainName": "niujf.top",
      "dnsNames": "",
      "buyTime": "2025-02-17 17:13:52",
      "applyTime": "2025-02-20 09:43:12",
      "startTime": "2025-01-09 00:00:00",
      "endTime": "2026-01-09 23:59:59",
      "algorithm": "RSA",
      "strength": "SHA256",
      "keyStrength": 2048,
      "authMethods": "cname",
      "orgCode": "98cd386ee67841c18c66f7be0f359ceb",
      "contactCode": "98cd386ee67841c18c66f7be0f359ceb"
    },
    "revokeTips": "吊销提示ccc",
    "appendDomainNameTips": "追加域名提示aaa"
  }
}

{
  "status": false,
  "code": "400",
  "msg": "服务不存在"
}

返回结果 - 证书追加域名初始化

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 证书追加域名初始化

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	返回结果
»» revokeTips	string	true	none	吊销提示语
»» appendDomainNameTips	string	true	none	追加域名提示语
»» service	object	true	none	服务信息
»»» serviceCode	string	true	none	服务编号
»»» sslName	string	true	none	证书名称
»»» goodsCode	string	true	none	商品编号
»»» goodsName	string	true	none	商品名称
»»» validityMonths	integer	true	none	证书有效期(月)
»»» timeAmount	integer	true	none	购买时长
»»» timeUnit	string	true	none	购买时间单位（M.Y.C）
»»» sslStatus	string	true	none	证书状态
»»» domainName	string	true	none	域名
»»» dnsNames	string	true	none	备用域名，多域名逗号分隔
»»» buyTime	string	true	none	购买时间
»»» applyTime	string	true	none	申请时间
»»» algorithm	string	true	none	加密算法
»»» strength	string	true	none	加密摘要
»»» keyStrength	integer	true	none	秘钥强度
»»» authMethods	string	true	none	认证方式
»»» orgCode	string	true	none	组织编号
»»» contactCode	string	true	none	联系人编号

证书追加域名

POST /ssl/v1/order/appendDomain

注意：

在重颁发时需要谨慎，购买的证书如果是多域名证书时，重颁发的域名必须以*.开头
支持重颁发条件：证书状态为已签发(issued)、即将到期(need_renew)或者待申请(unstart),同时必须是多域名证书

{
  "algorithm": "RSA",
  "authMethods": "dns",
  "dnsNames": "abc.xinnet.com,aa.xinnet.com",
  "domainName": "test.xinnet.com",
  "keyStrengthStr": "2048",
  "serviceCode": "ad19b8b3f7a5464aac15295744ca6194",
  "strength": "SHA256",
  "skipForceGivenDomain ": false
}

请求参数 - 证书追加域名

名称	位置	类型	必选	说明
» serviceCode	body	string	是	服务编号
» algorithm	body	string	是	加密算法枚举值: RSA/SM2/ECDSA
» keyStrengthStr	body	string	是	秘钥强度 RSA: 2048, 4096, 8192; ECDSA: 224, 256, 384; SM2: 256
» authMethods	body	string	是	认证方式 DNS, FILE, CNAME, TXT, EMAIL
» domainName	body	string	是	域名
» dnsNames	body	string	否	备用域名，多域名逗号分隔
» skipForceGivenDomain	body	boolean	否	取消赠送域名www，默认true.当申请域名为主域名时，默认是不赠送www域名，如需要赠送www则需要此参数传false.

{
  "status": true,
  "code": "200",
  "res": {}
}

{
  "status": false,
  "code": "400",
  "msg": "不支持追加域名"
}

返回结果 - 证书追加域名

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - 证书追加域名

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

工作流接口说明

工作流接口用于基于已签发证书配置和运行自动化流程，并管理流程中使用的自定义节点。

注意：

下述接口均使用 POST 请求，并需要按开放 API 规范传递鉴权参数。
请求中的用户信息由网关根据鉴权账号自动识别，不需要传递 userName。
工作流中的证书服务编号可以为新网签发证书或已录入的第三方证书服务编号；启动流程时会校验证书是否有效。
接口地址按照开放 API 地址展示；网关服务内部映射前缀为 /api/gateway。

下述接口的基础返回格式一致，各接口有业务数据时，其 res 数据结构在对应接口说明中列出。

返回示例

{
  "status": true,
  "code": "200",
  "res": {}
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	object	false	none	返回结果

工作流枚举

枚举类型	值	说明
流程定义状态	`draft`	草稿
流程定义状态	`enable`	启用
流程定义状态	`disable`	禁用
任务状态	`pending`	未运行
任务状态	`running`	运行中
任务状态	`completed`	成功
任务状态	`failed`	错误
任务状态	`disable`	已禁用
任务状态	`all`	全部

工作流流程定义

POST 添加流程定义

POST /ssl/v1/workflow/flowDefinition/addDefinition

{
  "name": "证书自动部署",
  "description": "证书签发后自动发布到负载均衡",
  "dsl": "[{\"nodeId\":\"deploy-lb\",\"nodeIds\":[],\"retryCount\":1,\"triggerSource\":\"manual\"}]",
  "executeType": 1,
  "certServiceCode": "ssl-service-code",
  "domain": "www.example.com"
}

请求参数

名称	位置	类型	必选	说明
» name	body	string	否	流程名称
» description	body	string	否	流程描述
» dsl	body	string	是	流程节点 JSON 字符串，至少包含一个节点，依赖节点必须已在该 JSON 中定义
» executeType	body	integer	否	执行方式： `0` 定时执行、 `1` 立即执行
» cronExpression	body	string	否	定时规则，定时执行时传递
» certServiceCode	body	string	否	证书服务编号
» certName	body	string	否	证书名称
» certType	body	string	否	证书类型
» domain	body	string	否	证书域名

dsl 中单个节点的数据结构：

名称	类型	必选	说明
» nodeId	string	是	节点标识
» nodeIds	[string]	否	当前节点依赖的节点标识列表
» waitingEvent	string	否	节点等待事件信息
» retryCount	integer	否	节点重试次数
» triggerSource	string	否	触发来源，如自动调度、外部回调或手动触发

POST 获取流程定义

POST /ssl/v1/workflow/flowDefinition/getDefinition/

请求参数

名称	位置	类型	必选	说明
» definitionCode	path	string	是	流程定义编号

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	object	true	none	流程定义信息
»» code	string	false	none	流程定义编号
»» name	string	false	none	流程名称
»» description	string	false	none	流程描述
»» dsl	[array]	false	none	流程节点定义列表
»» version	integer	false	none	流程定义版本号
»» status	string	false	none	流程定义状态
»» executeType	integer	false	none	执行方式
»» cronExpression	string	false	none	定时规则
»» certServiceCode	string	false	none	证书服务编号
»» domain	string	false	none	证书域名

POST 启动流程

POST /ssl/v1/workflow/flowDefinition/startDefinition

{
  "definitionCode": "workflow-code",
  "certServiceCode": "ssl-service-code"
}

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	要启动的流程定义编号
» certServiceCode	body	string	是	已签发证书或第三方证书的服务编号

POST 复制流程

POST /ssl/v1/workflow/flowDefinition/copyDefinition

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	被复制的流程定义编号

POST 重试流程节点

POST /ssl/v1/workflow/flowDefinition/retryNode

{
  "definitionCode": "workflow-code",
  "taskCode": "task-code",
  "nodeId": "deploy-lb"
}

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	流程定义编号
» taskCode	body	string	是	流程实例任务编号
» nodeId	body	string	是	要重试的节点标识

POST 修改流程定义内容

POST /ssl/v1/workflow/flowDefinition/modifyDefinition

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	流程定义编号
» name	body	string	否	流程名称
» description	body	string	否	流程描述
» dsl	body	string	否	流程节点 JSON 字符串
» executeType	body	integer	否	执行方式： `0` 定时执行、 `1` 立即执行
» cronExpression	body	string	否	定时规则

POST 修改流程证书

POST /ssl/v1/workflow/flowDefinition/modifyDefinitionCert

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	流程定义编号
» certServiceCode	body	string	是	新证书服务编号
» certName	body	string	否	证书名称
» certType	body	string	否	证书类型
» domain	body	string	否	证书域名

POST 修改流程定义状态

POST /ssl/v1/workflow/flowDefinition/changeDefinitionStatus

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	流程定义编号
» flowDefinitionStatus	body	string	是	流程状态： `draft`、 `enable`、 `disable`

POST 删除流程定义

POST /ssl/v1/workflow/flowDefinition/deleteDefinition

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	流程定义编号

POST 获取流程实例列表

POST /ssl/v1/workflow/flowDefinition/getFlowInstanceTaskList//

{
  "taskStatus": "all",
  "flowName": "证书自动部署",
  "certServiceCode": "ssl-service-code",
  "sortField": "createTime",
  "orderMethod": "desc"
}

请求参数

名称	位置	类型	必选	说明
» page	path	integer	是	当前页码，从 `1` 开始
» size	path	integer	是	每页条数
» taskStatus	body	string	是	任务状态，枚举见“工作流枚举”
» domain	body	string	否	证书域名
» userType	body	string	否	用户类型
» flowName	body	string	否	流程名称
» certServiceCode	body	string	否	证书服务编号
» lastRunTime	body	string	否	最近运行日期，格式 `yyyy-MM-dd`
» createTime	body	string	否	创建日期，格式 `yyyy-MM-dd`
» serviceEndTime	body	string	否	服务到期日期，格式 `yyyy-MM-dd`
» agentType	body	string	否	账号类型
» sortField	body	string	否	排序字段： `createTime`、 `lastRunTime`
» orderMethod	body	string	否	排序方式： `asc`、 `desc`

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	object	true	none	分页结果
»» total	integer	true	none	总记录数
»» page	integer	true	none	总页数
»» size	integer	true	none	每页条数
»» current	integer	true	none	当前页码
»» elements	[array]	true	none	当前页流程实例列表
»»» definitionCode	string	false	none	流程定义编号
»»» taskCode	string	false	none	流程实例任务编号
»»» taskStatus	object	false	none	任务状态枚举对象
»»» taskName	string	false	none	流程名称
»»» certServiceCode	string	false	none	证书服务编号
»»» definitionStatus	object	false	none	流程定义状态枚举对象
»»» lastRunTime	string	false	none	最近运行时间
»»» createTime	string	false	none	创建时间
»»» serviceEndTime	string	false	none	服务到期时间
»»» domain	string	false	none	证书域名
»»» certName	string	false	none	证书名称

POST 获取流程最新节点错误信息

POST /ssl/v1/workflow/flowDefinition/getErrorInfoByDefinition

请求参数

名称	位置	类型	必选	说明
» definitionCode	body	string	是	流程定义编号

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	[array]	true	none	节点错误信息列表
»» nodeId	string	false	none	节点标识
»» errorMsg	string	false	none	错误信息
»» runTime	string	false	none	运行时间

POST 获取任务状态枚举

POST /ssl/v1/workflow/flowDefinition/getTaskStatusEnumList

请求参数

名称	位置	类型	必选	说明
无	-	-	否	无业务参数，仍需要按开放 API 规范传递鉴权参数

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	[array]	true	none	任务状态枚举列表
»» code	string	true	none	任务状态值
»» desc	string	true	none	任务状态描述

工作流自定义节点

自定义节点数据结构

名称	类型	必选	说明
» classifyCode	string	否	节点分类唯一标识
» nodeId	string	修改/删除时是	节点标识
» nodeName	string	否	节点名称
» plugin	string	否	节点插件名或执行器标识
» customParameters	[array]	否	自定义请求参数列表，每项包含 `name`、 `value`、 `required`
» resultParameters	object	否	节点返回参数定义或示例
» webhookUrl	string	否	Webhook 回调地址
» webhookMethod	string	否	Webhook 请求方法，如 `GET`、 `POST`、 `PUT`、 `DELETE`
» webhookHeaders	string	否	Webhook 请求头 JSON 字符串
» webhookBody	string	否	Webhook 请求体 JSON 字符串
» webhookEnabled	boolean	否	是否启用 Webhook
» emailEnabled	boolean	否	是否启用邮件通知
» contactInfos	[array]	否	通知联系人列表，每项包含 `contact`、 `email`、 `id`、 `name`
» configured	boolean	否	是否已配置完成
» version	integer	否	节点版本号
» enabled	boolean	否	节点是否启用
» cronStartTime	string	否	定时任务开始时间
» cronEndTime	string	否	定时任务结束时间
» successNotifySwitch	boolean	否	任务成功通知开关
» failedNotifySwitch	boolean	否	任务失败通知开关

POST 获取节点分类

POST /ssl/v1/workflow/flowNodeDefinition/getNodeClassify

请求参数

名称	位置	类型	必选	说明
无	-	-	否	无业务参数，仍需要按开放 API 规范传递鉴权参数

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	[array]	true	none	节点分类列表
»» code	string	false	none	分类标识
»» type	string	false	none	分类类型
»» name	string	false	none	分类名称
»» sort	integer	false	none	排序号

POST 获取节点模板

POST /ssl/v1/workflow/flowNodeDefinition/getNodeTemplate/

请求参数

名称	位置	类型	必选	说明
» classifyCode	path	string	是	节点分类唯一标识

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	[array]	true	none	节点模板列表
»» code	string	false	none	节点模板标识
»» classifyCode	string	false	none	节点分类标识
»» name	string	false	none	节点名称
»» plugin	string	false	none	插件或执行器标识
»» description	string	false	none	节点描述
»» parameters	[array]	false	none	参数模板
»» resultParameters	object	false	none	返回参数定义

POST 查询自定义节点

POST /ssl/v1/workflow/flowNodeDefinition/getCustomNode

请求参数

名称	位置	类型	必选	说明
» classifyCode	body	string	否	节点分类唯一标识
» nodeIds	body	[string]	否	节点标识列表
» plugin	body	string	否	节点插件或执行器标识
» definitionCode	body	string	否	流程定义编号

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	[array]	true	none	自定义节点列表，字段见“自定义节点数据结构”

POST 新增自定义节点

POST /ssl/v1/workflow/flowNodeDefinition/addCustomNode

{
  "customNodes": [
    {
      "classifyCode": "deploy",
      "nodeId": "deploy-lb",
      "nodeName": "发布至负载均衡",
      "plugin": "webhook",
      "webhookUrl": "https://example.com/hooks/deploy",
      "webhookMethod": "POST",
      "webhookEnabled": true,
      "configured": true,
      "enabled": true
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
» customNodes	body	[array]	是	待新增的自定义节点列表，单项字段见“自定义节点数据结构”

POST 删除自定义节点

POST /ssl/v1/workflow/flowNodeDefinition/deleteCustomNode

请求参数

名称	位置	类型	必选	说明
» nodeId	body	string	是	节点标识

POST 修改自定义节点

POST /ssl/v1/workflow/flowNodeDefinition/updateCustomNode

请求参数

名称	位置	类型	必选	说明
» nodeId	body	string	是	要修改的节点标识
其他字段	body	-	否	可修改字段见“自定义节点数据结构”

Last modified: 25 May 2026

证书开放API文档

证书状态回调配置说明

1.配置回调地址及secretKey

2.回调参数说明

证书状态说明

注意事项：

1.只有DV类型证书不需要上传确认函，其他类型证书都需要上传确认函。

2.获取DCV解析值只有在 待审核、待验证、已签发三个状态时才能获取。

3.申请证书提交后，假如是申请的DV类型证书 ，状态会很快由待审核变成待验证；假如是OV或者EV类型则需要上传确认函审核通过了才能变成待验证。

API列表

POST 证书商品规格列表

返回结果 - POST 证书商品规格列表

返回数据结构 - POST 证书商品规格列表

POST 购买证书

请求参数 - POST 购买证书

返回结果 - POST 购买证书

返回数据结构 - POST 购买证书

POST 续费证书

请求参数 - POST 续费证书

返回结果 - POST 续费证书

返回数据结构 - POST 续费证书

POST 添加组织

请求参数 - POST 添加组织

返回结果 - POST 添加组织

返回数据结构 - POST 添加组织

POST 获取组织

请求参数 - POST 获取组织

返回结果 - POST 获取组织

返回数据结构 - POST 获取组织

POST 修改组织

请求参数 - POST 修改组织

返回结果 - POST 修改组织

返回数据结构 - POST 修改组织

POST 删除组织

请求参数 - POST 删除组织

返回结果 - POST 删除组织

返回数据结构 - POST 删除组织

POST 添加联系人

请求参数 - POST 添加联系人

返回结果 - POST 添加联系人

返回数据结构 - POST 添加联系人

POST 获取联系人

请求参数 - POST 获取联系人

返回结果 - POST 获取联系人

返回数据结构 - POST 获取联系人

POST 修改联系人

请求参数 - POST 修改联系人

返回结果 - POST 修改联系人

返回数据结构 - POST 修改联系人

POST 删除联系人

请求参数 - POST 删除联系人

返回结果 - POST 删除联系人

返回数据结构 - POST 删除联系人

POST 查询证书服务列表

请求参数 - POST 查询证书服务列表

返回结果 - POST 查询证书服务列表

返回数据结构 - POST 查询证书服务列表

POST 申请证书

请求参数 - POST 申请证书

返回结果 - POST 申请证书

返回数据结构 - POST 申请证书

POST 续签证书

请求参数 - POST 续签证书

返回结果 - POST 续签证书

返回数据结构 - POST 续签证书

POST 取消订单

请求参数 - POST 取消订单

返回结果 - POST 取消订单

返回数据结构 - POST 取消订单

POST 获取证书数据

请求参数 - POST 获取证书数据

返回结果 - POST 获取证书数据

返回数据结构 - POST 获取证书数据

POST 获取DCV解析信息

请求参数 - POST 获取DCV解析信息

返回结果 - POST 获取DCV解析信息

返回数据结构 - POST 获取DCV解析信息

POST 下载证书

请求参数 - POST 下载证书

返回结果 - POST 下载证书

2.获取DCV解析值只有在待审核、待验证、已签发三个状态时才能获取。

3.申请证书提交后，假如是申请的DV类型证书，状态会很快由待审核变成待验证；假如是OV或者EV类型则需要上传确认函审核通过了才能变成待验证。