链接列表

Notes
专家级
应用API接口密钥应该作为承载令牌在请求的授权头中发送 获取您的应用API接口密钥.
目录

API 接口:

GET
http://5ml.cn/api/v1/links

请求示例:

curl --location --request GET 'http://5ml.cn/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
参数
类型
描述
search
可选择的 string
The search query.
by
可选择的 string
Search by. Possible values are: title for 标题, alias for 自定义后缀, url for 链接.
status
可选择的 integer
Filter by status. Possible values are: 0 for 全部, 1 for 活跃的, 2 for 到期, 3 for 禁用.
space
可选择的 integer
Filter by space id.
domain
可选择的 integer
Filter by domain id.
sort
可选择的 string
Sort by. Possible values are: desc for Descending, asc for Ascending, max for 最佳, min for 最差.
显示

API 接口:

GET
http://5ml.cn/api/v1/links/{id}

请求示例:

curl --location --request GET 'http://5ml.cn/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API 接口:

POST
http://5ml.cn/api/v1/links

请求示例:

curl --location --request POST 'http://5ml.cn/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
参数
类型
描述
url
需要 string
要缩短的链接
alias
可选择的 string
链接后缀
password
可选择的 string
链接密码
space
可选择的 integer
保存链接的空间id
domain
可选择的 integer
要保存链接的域id
disabled
可选择的 integer
Whether the link is disabled or not. Defaults to: 0.
public
可选择的 integer
Whether the link stats are public or not. Defaults to: 0.
expiration_url
可选择的 string
一旦链接过期,用户将被重定向的链接
expiration_date
可选择的 string
链接到期日期采用:格式
expiration_time
可选择的 string
格式格式的链接到期时间
expiration_clicks
可选择的 integer
链接过期后的点击次数
target_type
可选择的 integer
The type of targeting. Possible values are: 0 for , 1 for 地理位置, 2 for 平台, 3 for 多链接随机跳转.
geo[index][key]
可选择的 string
目标国家的代码,代码必须符合:标准标准
geo[index][value]
可选择的 string
用户将被重定向到的国家链接
platform[index][key]
可选择的 string
The name of the targeted platform. Possible values are: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
可选择的 string
用户将被重定向到的平台链接
rotation[index][value]
可选择的 string
用户将被重定向到的跳转链接
更新

API 接口:

PUT PATCH
http://5ml.cn/api/v1/links/{id}

请求示例:

curl --location --request PUT 'http://5ml.cn/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
参数
类型
描述
url
可选择的 string
要缩短的链接
alias
可选择的 string
链接后缀
password
可选择的 string
链接密码
space
可选择的 integer
保存链接的空间id
domain
可选择的 integer
要保存链接的域id
disabled
可选择的 integer
Whether the link is disabled or not. Defaults to: 0.
public
可选择的 integer
Whether the link stats are public or not. Defaults to: 0.
expiration_url
可选择的 string
一旦链接过期,用户将被重定向的链接
expiration_date
可选择的 string
链接到期日期采用:格式
expiration_time
可选择的 string
格式格式的链接到期时间
expiration_clicks
可选择的 integer
链接过期后的点击次数
target_type
可选择的 integer
The type of targeting. Possible values are: 0 for , 1 for 地理位置, 2 for 平台, 3 for 多链接随机跳转.
geo[index][key]
可选择的 string
目标国家的代码,代码必须符合:标准标准
geo[index][value]
可选择的 string
用户将被重定向到的国家链接
platform[index][key]
可选择的 string
The name of the targeted platform. Possible values are: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
可选择的 string
用户将被重定向到的平台链接
rotation[index][value]
可选择的 string
用户将被重定向到的跳转链接
删除

API 接口:

DELETE
http://5ml.cn/api/v1/links/{id}

请求示例:

curl --location --request DELETE 'http://5ml.cn/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'