API - 创建短链接
侯小猴
发布于 2024-08-09 13:53:17
接口地址
https://api.xiaomark.com/v1/link/create
请求方法
POST
请求参数
参数名 | 类型 | 是否必传 | 描述 |
---|---|---|---|
apikey | string | 是 | 用户的API密钥 |
origin_url | string | 是 | 跳转链接,必须是以 http:// 或者 https:// 开头的链接或应用跳转链接 |
group_sid | string | 是 | 链接分组的sid,可在网页端 API 短链列表中查找 |
domain | string | 否 | 自定义域名,不填则默认使用sourl.cn;使用自定义域名可以生成任意域名下的短链接 |
report | bool | 否 | 是否返回可视化数据报表的查看链接,默认不返回;注:只有账号的API套餐里包含了可视化数据报表的功能,该字段生效 |
webhook | bool | 否 | 是否开启Webhook推送,默认不开启;(注:只有账号的API套餐里包含了Webhook推送的功能,且在 API 设置 里开启了推送,该字段才生效) |
webhook_scene | string | 否 | Webhook推送场景值,会包含在每次推送给用户的数据中,可以填写任意参数值,长度不超过128个字符 |
请求POST数据示例
{
"apikey": "361f534e9897e75af4206ea820365fde",
"domain": "interval.im",
"origin_url": "https://xiaomark.com/",
"group_sid": "w7ho5te8",
"report": true,
"webhook": true,
"webhook_scene": "test"
}
返回参数说明
名称 | 类型 | 描述 |
---|---|---|
code | integer | 返回码 |
message | string | 错误信息 |
data | object | 请求成功返回的数据 |
data.group | object数组 | 链接分组,详见 分组信息 |
data.link | object | 短链接,详见 短链接信息 |
data.n_links_today | integer | 今天通过接口已创建的短链接数量 |
data.report_url | string | 可视化数据报表链接 |
分组信息 group
名称 | 类型 | 描述 |
---|---|---|
sid | string | sid |
name | string | 分组名称 |
短链接信息 link
名称 | 类型 | 描述 |
---|---|---|
name | string | 链接名称 |
origin_url | string | 跳转链接URL |
url | string | 短链接URL |
返回结果示例
{
"code": 0,
"data": {
"group": {
"name": "分组1",
"sid": "w7ho5te8"
},
"link": {
"name": "短链接HOHzsG",
"origin_url": "https://xiaomark.com/",
"url": "https://sourl.cn/HOHzsG"
},
"report_url": "https://sourl.cn/oasl/Ch0w11y14KotWo3kOJnRCgq1",
"n_links_today": 13
},
"message": "请求成功",
}