生成 SSL 审核链接

POST

/openapi/v3/orders/:id/ssl-audit-link

为指定 SSL 订单生成终端用户可打开的证书审核链接。链接页面用于匿名完成域名验证、组织验证材料提交等审核动作。

调用影响

每次调用都会刷新该订单的审核链接：当前有效链接会失效，接口返回新的 access_url，需要把新地址重新发给终端用户。新链接的有效期从它首次被打开起重新计算。

路径参数

参数	类型	必填	说明
id	string	是	订单 ID

Body 参数

请求体可为空。每次调用都会新建一条审核链接，新链接的配置完全来自本次请求：不传 ui_config 使用默认页面配置，不传 prefill_data 不预填审核信息，不传 capabilities 不关闭任何能力。接口不会读取旧链接的配置，需要保留的配置请在每次调用时重新传入；想恢复默认配置，不传即可。

参数	类型	必填	说明
capabilities	object	否	审核链接能力限制，用于关闭链接页面上的指定能力
∟ disabled	array[string]	否	要关闭的能力列表，取值见可关闭的能力；为空或不传表示不关闭任何能力
ui_config	object	否	审核链接页面配置
∟ language	string	否	页面语言标识
∟ theme_color	string	否	页面主题色
∟ logo_url	string	否	页面 Logo URL
∟ hide_header	boolean	否	是否隐藏页面导航头
prefill_data	object	否	审核链接页面预填信息
∟ organization_validation	object	否	组织验证方式预填
∟ method	string	是	组织验证方式：public_phone、public_email、organization_material
∟ source	integer	否	公开电话或公开邮箱来源编码；method=public_phone/public_email 时必填
∟ phone	string	否	企业公开电话；method=public_phone 时必填
∟ email	string	否	企业公开邮箱；method=public_email 时必填

可关闭的能力

capabilities.disabled 列出要关闭的能力，列表中没有的能力保持开放。限制绑定在本次生成的链接上，页面和对应的匿名接口都会生效。

取值	关闭后的表现
certificate_download	证书签发后，审核链接页面不提供证书下载入口，匿名下载接口同样拒绝
organization_material_method	组织验证不再提供「企业认证材料」方式（该方式需要上传资料），包括选择该方式、上传和提交材料；企业公开电话、企业公开邮箱方式不受影响

传值规则：

• 不传 capabilities，等于不关闭任何能力。限制只作用于本次生成的链接，不会带到下一次调用，需要保留某项限制时每次都要在 disabled 中重新列出。
• disabled 中出现不认识的值时直接返回 ssl_order_audit_link_capability_invalid，不会被忽略，避免因拼写错误导致能力仍然开放；重复的值会被合并。
• 同一请求中既关闭 organization_material_method，又在 prefill_data.organization_validation.method 预填 organization_material，请求会被拒绝（ssl_order_audit_link_org_prefill_invalid）。

当前公开产品支持的组织验证来源

organization_validation.source 会按订单产品对应 CA 校验。请求中应传入下表的数字编码，中文仅用于说明来源含义。

CA	method	source 编码	说明
TrustAsia	public_phone	101	企查查电话
TrustAsia	public_phone	103	官网电话
TrustAsia	public_phone	105	百度地图电话
TrustAsia	public_phone	106	114 电话
TrustAsia	public_phone	107	谷歌地图
TrustAsia	public_phone	109	黄页
TrustAsia	public_phone / public_email	110	kompass
TrustAsia	public_phone	114	上海证券交易所
TrustAsia	public_phone	115	深圳证券交易所
TrustAsia	public_phone	116	北京证券交易所
TrustAsia	public_phone	117	全国中小企业股份转让系统
TrustAsia	public_phone	118	PCCW 电话
TrustAsia	public_phone	301	电话账单（近三个月）
TrustAsia	public_email	102	企查查邮箱
TrustAsia	public_email	104	官网邮箱
TrustAsia	public_email	111	PCCW（香港）
TrustAsia	public_email	114	上海证券交易所
TrustAsia	public_email	115	深圳证券交易所
TrustAsia	public_email	116	北京证券交易所
TrustAsia	public_email	117	全国中小企业股份转让系统
CertUM	public_email	102	企查查邮箱
CertUM	public_email	112	邮箱域名归申请人所有的所有邮箱
CertUM	public_email	113	邮箱域名归申请人母公司所有的所有邮箱
CertUM	public_email	119	企业邮箱
TrustAsia / CertUM	organization_material	-	不需要传 source、phone、email

请求示例

配置页面与预填信息

示例邮箱统一使用 mail@example.com，调用前请替换为实际业务邮箱。

curl -X POST 'https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link' \
  -H 'Content-Type: application/json' \
  -H 'X-CC-Auth-Key: your-auth-key' \
  -H 'X-CC-Key-ID: your-key-id' \
  -d '{
    "ui_config": {
      "language": "zh-CN",
      "theme_color": "#1a73e8",
      "logo_url": "https://example.com/logo.png",
      "hide_header": false
    },
    "prefill_data": {
      "organization_validation": {
        "method": "public_email",
        "source": 104,
        "email": "mail@example.com"
      }
    }
  }'

const response = await fetch('https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-CC-Auth-Key': 'your-auth-key',
    'X-CC-Key-ID': 'your-key-id',
  },
  body: JSON.stringify({
    ui_config: {
      language: 'zh-CN',
      theme_color: '#1a73e8',
      logo_url: 'https://example.com/logo.png',
      hide_header: false
    },
    prefill_data: {
      organization_validation: {
        method: 'public_email',
        source: 104,
        email: 'mail@example.com'
      }
    }
  })
})
const data = await response.json()

body := map[string]interface{}{
  "ui_config": map[string]interface{}{
    "language":    "zh-CN",
    "theme_color": "#1a73e8",
    "logo_url":    "https://example.com/logo.png",
    "hide_header": false,
  },
  "prefill_data": map[string]interface{}{
    "organization_validation": map[string]interface{}{
      "method": "public_email",
      "source": 104,
      "email":  "mail@example.com",
    },
  },
}
jsonBody, _ := json.Marshal(body)
req, _ := http.NewRequest("POST",
  "https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link",
  bytes.NewBuffer(jsonBody))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-CC-Auth-Key", "your-auth-key")
req.Header.Set("X-CC-Key-ID", "your-key-id")
resp, err := http.DefaultClient.Do(req)

import requests

response = requests.post(
    'https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link',
    headers={
        'Content-Type': 'application/json',
        'X-CC-Auth-Key': 'your-auth-key',
        'X-CC-Key-ID': 'your-key-id',
    },
    json={
        'ui_config': {
            'language': 'zh-CN',
            'theme_color': '#1a73e8',
            'logo_url': 'https://example.com/logo.png',
            'hide_header': False,
        },
        'prefill_data': {
            'organization_validation': {
                'method': 'public_email',
                'source': 104,
                'email': 'mail@example.com',
            },
        },
    },
)
data = response.json()

关闭证书下载与材料上传

这里只传 capabilities，页面配置和预填信息使用默认值。

curl -X POST 'https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link' \
  -H 'Content-Type: application/json' \
  -H 'X-CC-Auth-Key: your-auth-key' \
  -H 'X-CC-Key-ID: your-key-id' \
  -d '{
    "capabilities": {
      "disabled": ["certificate_download", "organization_material_method"]
    }
  }'

const response = await fetch('https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-CC-Auth-Key': 'your-auth-key',
    'X-CC-Key-ID': 'your-key-id',
  },
  body: JSON.stringify({
    capabilities: {
      disabled: ['certificate_download', 'organization_material_method']
    }
  })
})
const data = await response.json()

body := map[string]interface{}{
  "capabilities": map[string]interface{}{
    "disabled": []string{"certificate_download", "organization_material_method"},
  },
}
jsonBody, _ := json.Marshal(body)
req, _ := http.NewRequest("POST",
  "https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link",
  bytes.NewBuffer(jsonBody))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-CC-Auth-Key", "your-auth-key")
req.Header.Set("X-CC-Key-ID", "your-key-id")
resp, err := http.DefaultClient.Do(req)

import requests

response = requests.post(
    'https://api.certcloud.cn/openapi/v3/orders/order-xxx/ssl-audit-link',
    headers={
        'Content-Type': 'application/json',
        'X-CC-Auth-Key': 'your-auth-key',
        'X-CC-Key-ID': 'your-key-id',
    },
    json={
        'capabilities': {
            'disabled': ['certificate_download', 'organization_material_method'],
        },
    },
)
data = response.json()

响应示例

200成功

{
  "code": "success",
  "data": {
    "access_url": "https://www.certcloud.cn/ssl-order-audit-link?token=eyJhbGciOiJIUzI1NiIs..."
  }
}

常见错误码

code	说明
permission_denied	API Key 没有订单访问权限
order_not_found	订单不存在或不属于当前 API Key 账号
ssl_order_audit_link_product_unsupported	订单产品不支持 SSL 审核链接
ssl_order_audit_link_order_status_not_allowed	订单当前状态不允许生成或刷新审核链接
ssl_order_audit_link_theme_color_invalid	ui_config.theme_color 格式无效
ssl_order_audit_link_language_invalid	ui_config.language 不支持
ssl_order_audit_link_logo_url_invalid	ui_config.logo_url 无效
ssl_order_audit_link_org_prefill_invalid	组织验证预填参数无效；同一请求中预填了已被 capabilities.disabled 关闭的验证方式时同样返回
ssl_order_audit_link_capability_invalid	capabilities.disabled 中包含不支持的能力值