接口路径(新):http://api.okayapi.com/api/App/ShortUrl/Gen
接口路径(旧):http://api.okayapi.com/?s=App.ShortUrl.Gen
接口描述: 针对长链接,生成对应的短链接。生成后可直接使用短链接,并且在小白开放平台的短链接,可以进行管理和查看,并统计访问次数。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
url | String | Required | 完整的长链接,建议以http或https开头,例如:https://www.yesapi.cn/。如果缺少http为开头,则访问时自动会添加 http:// | ||
title | String | Required | 链接标题 |
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
url | String | 本次传递的长链接 |
short_url | String | 本次生成的短链接 |
code | String | 短链接代码编号 |
接口路径(新):http://api.okayapi.com/api/App/ShortUrl/GetList
接口路径(旧):http://api.okayapi.com/?s=App.ShortUrl.GetList
接口描述: 获取已经生成的短链接列表信息,包括标题、原始链接、访问次数统计,并且支持按创建时间排序和按访问次数排序,同时支持搜索功能。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
page | Int | Optaion | 1 | MIN: 1 | 页数 |
perpage | Int | Optaion | 20 | MIN: 1;MAX: 200 | 分页数量 |
sort_type | Int | Optaion | 1 | 排序类型,1是按创建时间降序,2是按访问次数降序 | |
search | String | Optaion | 模糊搜索标题或短链接代码 |
请求:
{OKAYAPI_API_HOST}/?s=App.ShortUrl.GetList&page=1&perpage=3&sort_type=1&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"items": [
{
"title": "test",
"code": "xjpaX4",
"url": "https://www.yesapi.cn/",
"add_time": "2019-09-23 21:30:03",
"visit_times": 30,
"short_url": "http://a.yesapi.cn/xjpaX4"
},
{
"title": "test",
"code": "nraBZ2",
"url": "https://www.yesapi.cn/",
"add_time": "2019-09-23 00:05:19",
"visit_times": 89,
"short_url": "http://a.yesapi.cn/nraBZ2"
},
{
"title": "test",
"code": "gzEwY4",
"url": "https://www.yesapi.cn/",
"add_time": "2019-09-21 23:58:54",
"visit_times": 200,
"short_url": "http://a.yesapi.cn/gzEwY4"
}
],
"total": 376
},
"msg": "小白开放接口:App.ShortUrl.GetList"
}
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
items | Array | 短链接列表 |
items[].title | String | 短链接标题 |
items[].code | String | 短链接代码 |
items[].url | String | 完整原始链接 |
items[].add_time | String | 添加时间 |
items[].visit_times | Int | 访问次数 |
items[].short_url | String | 短链接 |
total | Int | 总数 |
接口路径(新):http://api.okayapi.com/api/App/ShortUrl/Edit
接口路径(旧):http://api.okayapi.com/?s=App.ShortUrl.Edit
接口描述: 可编辑短链接标题和原始链接
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
code | String | Required | 需要修改的短链接代码 | ||
url | String | Required | 需要更新的完整链接,如果不需要修改请原路回传 | ||
title | String | Required | 需要更新的标题,如果不需要修改请原路回传 |
KEY | Type | Description |
---|---|---|
err_code | Int | 操作状态码,0成功,1短链接不存在或已被删除 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
接口路径(新):http://api.okayapi.com/api/App/ShortUrl/Remove
接口路径(旧):http://api.okayapi.com/?s=App.ShortUrl.Remove
接口描述: 可删除短链接,删除后短链接将失败,且不可恢复。
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
code | String | Required | 需要删除的短链接代码 |
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Sep/14/2024 12:27:28