API 鉴权

CertCloud OpenAPI v3 使用 API Key 认证。请在每个请求的 HTTP Header 中携带以下两个字段：

Header	必填	说明
`X-CC-Key-ID`	是	API Key ID，用于标识该 API Key
`X-CC-Auth-Key`	是	API Key，对应创建 API Key 时生成的完整密钥

签名说明

服务端收到 X-CC-Auth-Key 后，会使用 SHA256 对该值进行哈希，并与数据库中存储的哈希值比对。

由于全程使用 HTTPS，API Key 在传输过程中是加密的，客户端不需要自行计算 HMAC-SHA256 签名，只需在 Header 中明文传递即可。

请求示例

bash

curl -X GET 'https://api.certcloud.cn/openapi/v3/ping' \
  -H 'Content-Type: application/json' \
  -H 'X-CC-Key-ID: your-api-key-id' \
  -H 'X-CC-Auth-Key: your-api-key'

亦可以通过上面的请求测试接口连通性以及密钥是否正确。如果返回 Everything is fine, please enjoy it. 说明密钥正确，接口连通。

接口规范

基本信息

项目	说明
接口格式	JSON
测试环境	`https://api-uat.certcloud.cn/openapi/v3`
正式环境	`https://api.certcloud.cn/openapi/v3`

请求结构

请求 URI：协议 + 地址 + 服务器地址 + 资源路径
请求方法：GET、POST、PUT
请求消息头：
- X-CC-Key-ID：在 Web 端创建的 OpenAPI 密钥 ID
- X-CC-Auth-Key：在 Web 端创建的 OpenAPI 密钥
请求响应体：多为 JSON

强制要求

必须开启 HTTPS 访问
必须在 API 请求中携带"请求消息头"

返回结果

HTTP 状态码

状态码	说明
200	接口正常响应
400	接口参数或路径或鉴权异常
500	服务端异常

响应头

Header	说明
`X-CC-Request-ID`	当前 API 请求的唯一追踪 ID。

排障建议

如果 API 请求出错，请向技术支持提供响应头中的 X-CC-Request-ID，以便快速定位并排查该次请求。

响应体

接口返回数据除部分文件下载接口外，都为 JSON 格式：

json

{
  "code": "success",
  "data": {}
}

调用正常时，code 为 success，数据在 data 结构中
调用出错时，code 可参考错误码说明

API 鉴权 ​

请求示例 ​

接口规范 ​

基本信息 ​