链接

笔记
专家级
API密钥应该作为请求的授权头中的承载令牌发送。 获取您的 API 密钥.
列表

API 端点:

GET 
http://t.ysmj.xyz/api/v1/links

请求示例: 

curl --location --request GET 'http://t.ysmj.xyz/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
范围
类型
描述
search
可选 string
搜索查询。
search_by
可选 string
搜索方式. 可能的值是：标题 的 title, 别名 的 alias, 网址 的 url。 默认为：title。
status
可选 integer
按状态过滤。 可能的值是：全部 的 0, 积极的 的 1, 已到期 的 2, 已禁用 的 3。 默认为：0。
space_id
可选 integer
按群组 ID 过滤。
domain_id
可选 integer
按域 ID 过滤。
pixel_id
可选 integer
按像素 ID 过滤。
sort_by
可选 string
排序. 可能的值是：创建日期 的 id, 点击次数 的 clicks, 标题 的 title, 别名 的 alias, 网址 的 url。 默认为：id。
sort
可选 string
种类. 可能的值是：降序 的 desc, 上升 的 asc。 默认为：desc。
per_page
可选 integer
每页结果. 可能的值是：10, 25, 50, 100。 默认为：10。
显示

API 端点:

GET 
http://t.ysmj.xyz/api/v1/links/{id}

请求示例: 

curl --location --request GET 'http://t.ysmj.xyz/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
店铺

API 端点:

POST 
http://t.ysmj.xyz/api/v1/links

请求示例: 

curl --location --request POST 'http://t.ysmj.xyz/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
范围
类型
描述
url
必须 string
要缩短的链接。
domain_id
必须 integer
要保存链接的域 ID。
alias
可选 string
链接别名。
password
可选 string
链接密码。
space_id
可选 integer
要保存的链接的群组 ID。
pixel_ids
可选 array
The pixel IDs to be integrated in the link.
disabled
可选 integer
链接是否被禁用。 可能的值是：积极的 的 0, 已禁用 的 1。 默认为：0。
privacy
可选 integer
链接统计信息是否公开。 可能的值是：公开 的 0, 不公开 的 1, 密码 的 2。 默认为：0。
privacy_password
可选 string
统计页面的密码。 仅适用于 privacy 设置为 2。
expiration_url
可选 string
链接过期后将重定向用户的链接。
expiration_date
可选 string
YYYY-MM-DD 格式的链接到期日期。
expiration_time
可选 string
HH:MM 格式的链接过期时间。
expiration_clicks
可选 integer
链接应过期的点击次数。
target_type
可选 integer
定位类型。 可能的值是：没有任何 的 0, 地理 的 1, 平台 的 2, 回转 的 4。
country[index][key]
可选 string
目标国家的代码。 代码必须在 ISO 3166-1 alpha-2 标准中。
country[index][value]
可选 string
用户将被重定向到的链接。
platform[index][key]
可选 string
目标平台的名称。 可能的值是：iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS。
platform[index][value]
可选 string
用户将被重定向到的链接。
language[index][key]
可选 string
目标语言的代码。 代码必须在 ISO 639-1 alpha-2 标准中。
language[index][value]
可选 string
用户将被重定向到的链接。
rotation[index][value]
可选 string
用户将被重定向到的链接。
更新

API 端点:

PUT PATCH 
http://t.ysmj.xyz/api/v1/links/{id}

请求示例: 

curl --location --request PUT 'http://t.ysmj.xyz/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_id
可选 integer
要保存的链接的群组 ID。
pixel_ids
可选 array
The pixel IDs to be integrated in the link.
disabled
可选 integer
链接是否被禁用。 可能的值是：积极的 的 0, 已禁用 的 1。
privacy
可选 integer
链接统计信息是否公开。 可能的值是：公开 的 0, 不公开 的 1, 密码 的 2。
privacy_password
可选 string
统计页面的密码。 仅适用于 privacy 设置为 2。
expiration_url
可选 string
链接过期后将重定向用户的链接。
expiration_date
可选 string
YYYY-MM-DD 格式的链接到期日期。
expiration_time
可选 string
HH:MM 格式的链接过期时间。
expiration_clicks
可选 integer
链接应过期的点击次数。
target_type
可选 integer
定位类型。 可能的值是：没有任何 的 0, 地理 的 1, 平台 的 2, 回转 的 4。
country[index][key]
可选 string
目标国家的代码。 代码必须在 ISO 3166-1 alpha-2 标准中。
country[index][value]
可选 string
用户将被重定向到的链接。
platform[index][key]
可选 string
目标平台的名称。 可能的值是：iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS。
platform[index][value]
可选 string
用户将被重定向到的链接。
language[index][key]
可选 string
目标语言的代码。 代码必须在 ISO 639-1 alpha-2 标准中。
language[index][value]
可选 string
用户将被重定向到的链接。
rotation[index][value]
可选 string
用户将被重定向到的链接。
删除

API 端点:

DELETE 
http://t.ysmj.xyz/api/v1/links/{id}

请求示例: 

curl --location --request DELETE 'http://t.ysmj.xyz/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'