链接 - 开发者

备注

专家级别

API密钥应作为Bearer令牌放在请求Authorization头中发送获取您的API密钥.

列表

API端点:

GET

https://lurl.top/api/v1/links

请求示例:

curl --location --request GET 'https://lurl.top/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

https://lurl.top/api/v1/links/{id}

请求示例:

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

存储

API端点:

POST

https://lurl.top/api/v1/links

请求示例:

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

将要被嵌入链接以实现追踪功能的像素标识符

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

https://lurl.top/api/v1/links/{id}

请求示例:

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

将要被嵌入链接以实现追踪功能的像素标识符

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

https://lurl.top/api/v1/links/{id}

请求示例:

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