API文档 - XyzUrl

Notes

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

列出所有链接

API 接口:

GET

https://xyzurl.cn/api/v1/links

请求示例:

curl --location --request GET 'https://xyzurl.cn/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

显示

获取链接的详细信息

API 接口:

GET

https://xyzurl.cn/api/v1/links/{id}

请求示例:

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

Store

创建链接

API 接口:

POST

https://xyzurl.cn/api/v1/links

请求示例:

curl --location --request POST 'https://xyzurl.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

无论链接是否被禁用，默认为:值

public

可选择的 integer

无论链接状态是否为公共，默认为:值

expiration_url

可选择的 string

一旦链接过期，用户将被重定向的链接

expiration_date

可选择的 string

链接到期日期采用:格式

expiration_time

可选择的 string

格式格式的链接到期时间

expiration_clicks

可选择的 integer

链接过期后的点击次数

target_type

可选择的 integer

The type of targeting, the possible values are: 0 for 无, 1 for 地理位置, 2 for 平台, 3 for 多链接随机跳转.

geo[index][key]

可选择的 string

目标国家的代码，代码必须符合:标准标准

geo[index][value]

可选择的 string

用户将被重定向到的国家链接

platform[index][key]

可选择的 string

目标平台的名称。可能的价值是:平台

platform[index][value]

可选择的 string

用户将被重定向到的平台链接

rotation[index][value]

可选择的 string

用户将被重定向到的跳转链接

更新

更新链接

API 接口:

PUT PATCH

https://xyzurl.cn/api/v1/links/{id}

请求示例:

curl --location --request PUT 'https://xyzurl.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

无论链接是否被禁用，默认为:值

public

可选择的 integer

无论链接状态是否为公共，默认为:值

expiration_url

可选择的 string

一旦链接过期，用户将被重定向的链接

expiration_date

可选择的 string

链接到期日期采用:格式

expiration_time

可选择的 string

格式格式的链接到期时间

expiration_clicks

可选择的 integer

链接过期后的点击次数

target_type

可选择的 integer

The type of targeting, the possible values are: 0 for 无, 1 for 地理位置, 2 for 平台, 3 for 多链接随机跳转.

geo[index][key]

可选择的 string

目标国家的代码，代码必须符合:标准标准

geo[index][value]

可选择的 string

用户将被重定向到的国家链接

platform[index][key]

可选择的 string

目标平台的名称。可能的价值是:平台

platform[index][value]

可选择的 string

用户将被重定向到的平台链接

rotation[index][value]

可选择的 string

用户将被重定向到的跳转链接

删除

删除链接

API 接口:

DELETE

https://xyzurl.cn/api/v1/links/{id}

请求示例:

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