操作指南
API 完整参考
毛驴短链完整 API 参考:api_token 鉴权、创建短链、查询短链数据、修改短链及分组列表的参数与响应字段。
毛驴短链接 API 接入说明
使用说明
API 用于在业务系统中创建、查询与修改短链接,返回 JSON。先注册账号,在控制台的 API Token 页面获取令牌,再由业务服务器调用接口。
令牌属于账号凭据,不能放在公开网页、截图或前端代码中。轮换令牌会使旧令牌失效,请同步更新调用方。
第一次调用
- 注册毛驴短链,登录后打开 API Token 管理。
- 将令牌存入业务服务器环境变量
MAOLV_API_TOKEN。 - 创建一条测试短链,保存响应中的
id和short_link,再按下文查询结果。
curl --request POST 'https://www.maolvdl.com/apic/v1/api/cubes' \
--data-urlencode "api_token=${MAOLV_API_TOKEN}" \
--data-urlencode 'links=https://example.com/campaign' \
--data-urlencode 'cube_name=渠道入口测试'
links 是目标网址参数,不能写成 link。不要将真实令牌或客户网址复制到公开日志中。
使用前需要确认
- 免费体验链接创建后 10 分钟过期,不适合直接用于正式投放;编辑或升级不能延长已经创建的体验链接。
- 购买会员前须成功绑定自定义域名,参见 域名绑定指南;套餐对比见 公开价格页。
- 链接数量、可用功能与有效期受账号套餐和链接设置约束,不承诺无限调用。本文未给出统一每秒请求额度,接入前应核对当前账号权限。
- 本文的快速修改接口只支持普通短链,不覆盖设备、地域、时间和比例分流规则。
- 遇到鉴权失败,先核对令牌是否为空或已轮换;创建失败时核对参数、账号额度及目标地址。不要对参数错误进行无限重试。
新建短链
url https://www.maolvdl.com/apic/v1/api/cubes
action POST
description 创建短链
params
| name | description | type | required | remark |
|---|---|---|---|---|
| api_token | 授权的token | string | 是 | |
| links | 要缩短的链接 | string | 是 | 需要 https:// 或 http:// 开头, 注意是 links 不是 link |
| cube_name | 短链的名字 | string | 否 | 主要备注使用 |
| cube_short | 选择的短链 | string | 否 | 要挑选的 短链 |
| project_name | 组的名字 | string | 否 | 如果这个组不存在, 则会自动新建这个组 |
response
返回信息较多, 这里只提出对用户有用的信息
| name | description | type | remark |
|---|---|---|---|
| id | 短地址标识 | string | |
| short | 短地址标识 | string | 同id |
| short_link | 完整短地址 | string | |
| name | 短地址名称 | string | |
| created_at | 创建时间 | datetime | |
| links | 对应的links | Array | 具体结构参见create 中的link 表 |
| total_pv_count | 历史总计 PV | integer | 新建后的瞬间是没有数据的 |
| total_uv_count | 历史总计 UV | integer | 新建后的瞬间是没有数据的 |
| pv_count | 今日PV 数 | integer | 新建后的瞬间是没有数据的 |
| uv_count | 今日 UV 数 | integer | 新建后的瞬间是没有数据的 |
| yesterday_pv_count | 昨日PV 数 | integer | 新建后的瞬间是没有数据的 |
| yesterday_uv_count | 昨日 UV 数 | integer | 新建后的瞬间是没有数据的 |
link (item) 的有用结构
| name | description | type | remark |
|---|---|---|---|
| id | 编号 | string | 对应的link的编号 |
| url | 跳转地址 | string | 跳转的地址 |
| created_at | 创建时间 | datetime |
查看短链数据
url
https://www.maolvdl.com/apic/v1/api/cubes/{id}
action GET
description 显示 cube 的相关信息
params
| id | description | type | required | remark |
|---|---|---|---|---|
| api_token | 授权的token | string | 是 | |
| id | 对应的短连接 | stirng | 是 | 之前生成的 id |
response
返回信息较多, 这里只提出对用户有用的信息
| name | description | type | remark |
|---|---|---|---|
| id | 短地址标识 | string | |
| short | 短地址标识 | string | 同id |
| short_link | 完整短地址 | string | |
| name | 短地址名称 | string | |
| created_at | 创建时间 | datetime | |
| links | 对应的links | Array | 具体结构参见create 中的link 表 |
| total_pv_count | 历史总计 PV | integer | |
| total_uv_count | 历史总计 UV | integer | |
| pv_count | 今日PV 数 | integer | |
| uv_count | 今日 UV 数 | integer | |
| yesterday_pv_count | 昨日PV 数 | integer | |
| yesterday_uv_count | 昨日 UV 数 | integer |
修改短链
url
https://www.maolvdl.com/apic/v1/api/cubes/{id}/fast_modify
action POST
description 修改短链信息
params
| id | description | type | required | remark |
|---|---|---|---|---|
| api_token | 授权的token | string | 是 | |
| id | 对应的短连接 | stirng | 是 | 之前生成的 id |
| short | 短地址标识 | string | 否 | 修改后的短连接 |
| name | 短连接备注名称 | string | 否 | 修改后的短连接名称 |
| link | 修改后的跳转地址 | string | 否 | 暂只支持普通类型的短链(不包含设备、比例、时间、地域等特殊短链),注意不是 url |
普通短链修改目标示例(将 SHORT_LINK_ID 替换为创建响应中的 id):
curl --request POST 'https://www.maolvdl.com/apic/v1/api/cubes/SHORT_LINK_ID/fast_modify' \
--data-urlencode "api_token=${MAOLV_API_TOKEN}" \
--data-urlencode 'link=https://example.com/campaign-updated'
response
返回信息较多, 这里只提出对用户有用的信息
| name | description | type | remark |
|---|---|---|---|
| id | 短地址标识 | string | |
| short | 短地址标识 | string | 同id |
| short_link | 完整短地址 | string | |
| name | 短地址名称 | string | |
| created_at | 创建时间 | datetime | |
| links | 对应的links | Array | 具体结构参见create 中的link 表 |
| total_pv_count | 历史总计 PV | integer | |
| total_uv_count | 历史总计 UV | integer | |
| pv_count | 今日PV 数 | integer | |
| uv_count | 今日 UV 数 | integer | |
| yesterday_pv_count | 昨日PV 数 | integer | |
| yesterday_uv_count | 昨日 UV 数 | integer |
查看 分组列表
需联系客服开通
url
https://www.maolvdl.com/apic/v1/api/projects
action GET
description
params
| id | description | type | required | remark |
|---|---|---|---|---|
| api_token | 授权的token | string | 是 |
还有疑问?联系支持:jc@fir.im