Appearance
接口地址与状态信息
接口地址
sh
https://api-2.timecdn.cn/api/{接口名称}
输出格式
- 所有接口统一按照下方格式返回
JSON
格式数据。
json
{
"code": 200, // 状态码
"message": "请求成功", // 接口提示消息
"data": {}, // 接口返回数据内容
"docs": "https://api.timecdn.cn/docs/xxxx", // 接口文档地址
"requestId": "xxxxxxxxxxxx" // 本次请求ID
}
- 所有
GET
请求支持返回JSONP
格式,只需要在请求地址中添加callback
参数即可。
例:GET https://api-2.timecdn.cn/api/xxxx?callback=callback
js
callback({
"code": 200,
"message": "请求成功",
"data": {},
"docs": "https://api.timecdn.cn/docs/xxxx",
"requestId": "xxxxxxxxxxxx"
})
⚠️ 特别注意
部分图片类接口可能默认直接返回图像,需要添加参数 format=json
来获取 JSON
格式数据。
状态码
💬 提示
此状态码仅为返回结果的提示,和 HTTP 状态码不同,请勿混淆
- 2xx 为请求成功状态,其余为请求出错
错误码 | 说明 |
---|---|
200 | 请求成功 |
210 | 请求成功,但接口即将废弃,请及时更换新接口 |
- 1xx 为配额鉴权相关错误
错误码 | 说明 |
---|---|
110 | 请求来源未被授权,检查域名白名单 |
111 | 签名验证失败,检查签名验证 |
112 | IP未被授权,检查IP白名单 |
113 | 此接口功能未被授权 |
151 | 此Key每秒请求量已达到上限 |
152 | 此Key每日请求量已达到上限 |
160 | 此Key付费请求次数配额不足 |
190 | 无效的Key |
191 | 该Key无请求权限 |
- 3xx 为参数错误
错误码 | 说明 |
---|---|
310 | 缺少参数Key |
311 | 缺少必要的参数 |
316 | 参数格式错误 |
351 | 存在不共存的参数 |
- 4xx 为请求错误
错误码 | 说明 |
---|---|
404 | 接口不存在 |
405 | 请求方法错误 |
- 5xx 为系统错误
错误码 | 说明 |
---|---|
500 | 后端服务请求超时 |
510 | 后端服务无法连接 |
520 | 后端服务请求失败 |
600 | 其他 |