Appearance
测试回调配置
PUT
/openapi/v3/account/callback/test
向回调地址真实发送一条模拟的 order:issued 回调,用于检查地址、网络和鉴权密钥是否可用。测试不会保存任何配置。
请求方式与权限
- 空请求体:使用当前已保存的
url和access_key。 - 传入临时
url和/或access_key:与已保存配置合并后测试,不会写入数据库。 - 账户尚未配置回调时,必须同时传入
url和access_key。 测试请求不受已保存的disabled和enabled_actions限制。即使业务回调已暂停或order:issued不在白名单中,测试仍会发送。
Body 参数 application/json(可选)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
url | string | 否 | 临时回调地址,必须使用 HTTPS,最长 256 个字符 |
access_key | string | 否 | 临时回调鉴权密钥,最长 256 个字符 |
请求示例
测试当前已保存配置:
bash
curl -X PUT 'https://api.certcloud.cn/openapi/v3/account/callback/test' \
-H 'X-CC-Auth-Key: your-auth-key' \
-H 'X-CC-Key-ID: your-key-id'保存前预先测试新地址:
bash
curl -X PUT 'https://api.certcloud.cn/openapi/v3/account/callback/test' \
-H 'Content-Type: application/json' \
-H 'X-CC-Auth-Key: your-auth-key' \
-H 'X-CC-Key-ID: your-key-id' \
-d '{
"url": "https://gateway.example.com/callback?token=new-token",
"access_key": "new-callback-access-key"
}'测试回调内容
接收方会收到带有 X-CC-Callback-Auth 请求头的 HTTP POST。请求体包含以下模拟数据:
json
{
"action_type": "order",
"action_id": "order:issued",
"order_id": "test123",
"order_status": "issued",
"cert_id": "test789",
"message": "订单 test123(example.certcloud.cn) 已经成功签发"
}message 是服务端生成的本地化文本,请勿依赖其示例文案进行程序判断。
成功条件
目标地址必须返回 HTTP 200。网络异常、域名解析到私有地址或目标返回其他状态码都会导致测试失败。测试接口按账户限流,请勿高频调用。
相关错误码
| code | 说明 |
|---|---|
request_too_fast | 测试请求过于频繁 |
invalid_parameters | 请求体格式错误,或 URL/鉴权密钥为空 |
invalid_callback_url | URL 格式无效,或 URL/鉴权密钥超过长度限制 |
callback_url_not_https | URL 未使用 HTTPS |
callback_not_configured | 没有已保存配置,也未同时提供 URL 和鉴权密钥 |
callback_send_error | 网络、DNS、TLS 或超时等原因导致发送失败 |
callback_response_not_200 | 目标地址响应状态码不是 200 |
callback_private_domain | 回调域名解析到私有地址 |
permission_denied | Huawei SCM 内部 token、CMLite OAuth、CMC2MPKI 专用 API Key 无权调用;MPKI 账户使用标准 API Key 时传入临时 url 或 access_key 也会返回此错误 |
完整列表见错误码说明。
