Appearance
生成 SSL 审核链接
POST
/openapi/v3/orders/:id/ssl-audit-link
为指定 SSL 订单生成终端用户可打开的证书审核链接。链接页面用于匿名完成域名验证、组织验证材料提交等审核动作。
调用影响
每次调用都会刷新该订单的审核链接:当前有效链接会失效,接口返回新的 access_url。
路径参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 订单 ID |
Body 参数
请求体可为空。首次创建审核链接时,不传 ui_config 时使用默认页面配置,不传 prefill_data 时不预填审核信息;刷新已有有效链接时,未传入的对象沿用当前有效链接的对应配置,传入对象则以新对象覆盖。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 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 时必填 |
| string | 否 | 企业公开邮箱;method=public_email 时必填 |
当前公开产品支持的组织验证来源
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 |
请求示例
bash
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": "audit@example.com"
}
}
}'响应示例
常见错误码
| 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 | 组织验证预填参数无效 |
