短网址
创建可公开访问的短网址,并按当前API Key所属账号查询累计访问次数或停用短链。首版短码由服务器安全随机生成,不开放自定义短码;支持1~3650天有效期或永久有效。访问统计只累计次数与最后访问时间,不记录访客IP、User-Agent等个人访问标识。
补充说明
POST JSON /api/v1/endpoints/short-url,Bearer API Key。action=create/detail/disable;create需url,可选expire_days;detail/disable需code。公开访问地址为 /s/{code}。首版不开放自定义短码,不记录访客IP/UA。详细字段参见前台接口文档及 docs/API.md。请求参数
除 Bearer API Key 请求头外,使用 application/json 发送以下字段。图片接口的文件需先转成纯 Base64 字符串提交。
| 字段名称 | 格式 | 说明 |
|---|---|---|
action | 字符串 | 创建、查询详情或停用 |
url | 字符串 | create时必填;仅HTTP/HTTPS默认80/443端口,不允许本地/私网/保留地址及本站短链再次套短链 |
expire_days | 数字 | create时可选,1~3650;留空表示永久有效 |
code | 字符串 | detail/disable时必填,例如返回结果中的10位短码 |
非预期参数将被忽略;非法参数 HTTP 422。接口执行异常统一返回失败响应,不计为成功扣点。请仅提交您有权处理的文本、图片或网页内容。
示例代码
将密钥和业务字段替换为自己的实际值,不要在公开网页或 App 内写入管理员密钥。
cURL
curl -X POST "https://api.dcykjgw.com/api/v1/endpoints/short-url" \
-H "Authorization: Bearer dcy_你的完整密钥" \
-H "Content-Type: application/json" \
-d '{"action":"create","url":"https://api.dcykjgw.com/endpoints","expire_days":30}'
JavaScript
fetch('https://api.dcykjgw.com/api/v1/endpoints/short-url', {
method: 'POST',
headers: {'Content-Type':'application/json','Authorization':'Bearer dcy_你的完整密钥'},
body: JSON.stringify({"action":"create","url":"https://api.dcykjgw.com/endpoints","expire_days":30})
}).then(r => r.json()).then(console.log);
响应结构
{
"code": 0,
"msg": "处理成功",
"platform": "short-url",
"data": {
"code": "a1b2c3d4e5",
"short_url": "https://api.dcykjgw.com/s/a1b2c3d4e5",
"target_url": "https://api.dcykjgw.com/endpoints",
"status": "active",
"visit_count": 0,
"expires_at": "2026-11-14T15:51:00+08:00",
"last_visited_at": null
}
}action=create 创建短链并返回服务器生成短码;action=detail 查询当前账号短链状态与累计访问次数;action=disable 立即停用,之后访问返回 HTTP 410。首版不开放自定义短码,不记录访客 IP、User-Agent 或逐次访问明细。有效期到期后同样返回 HTTP 410;目标网址只允许 HTTP/HTTPS 默认端口,并拒绝本地、私网和保留地址。
返回参数说明
| 字段 | 格式 | 说明 |
|---|---|---|
code | 数字 | 业务状态码,0 表示本次接口调用成功;非 0 时结合 msg 和 HTTP 状态码排查。 |
msg | 字符串 | 本次请求结果说明,成功时描述处理结果,失败时给出可读错误原因。 |
platform | 字符串 | 当前接口/平台标识,成功响应中用于区分具体接口来源。 |
data | 对象 | 接口业务数据;具体字段含义见下方本接口字段说明。 |
data.code | 字符串 | 服务器生成的短码。 |
data.short_url | 字符串 | 可公开访问的短网址。 |
data.target_url | 字符串 | 短网址实际跳转目标。 |
data.status | 字符串 | 短链状态,例如 active 或 disabled。 |
data.visit_count | 数字 | 累计访问次数。 |
data.expires_at | 字符串/null | 过期时间;null 表示永久有效。 |
data.last_visited_at | 字符串/null | 最近一次访问时间。 |
data.created_at | 字符串/null | 短网址创建时间。 |
无效参数 HTTP 422;无效密钥 401;权限限制 403;点数不足 402;频率超限 429;服务暂不可用 503。
在线测试 · 短网址
请填写自己的 API Key。图片只上传到当前 API 请求,不保存到浏览器本地存储;图片 Base64 在下方结果中自动隐藏。
响应结果
填写参数后点击“发送测试请求”。