链接 - 开发者

备注

专家级别

API密钥应该作为请求的Authorization标头中的Bearer令牌发送获取你的API密钥.

列表

API端点:

GET

https://go.f27.net/api/v1/links

请求示例:

curl --location --request GET 'https://go.f27.net/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

可选的 int

每页结果数. 可能的值为：10, 25, 50, 100 默认值为：10

显示

API端点:

GET

https://go.f27.net/api/v1/links/{id}

请求示例:

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

存储

API端点:

POST

https://go.f27.net/api/v1/links

请求示例:

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

https://go.f27.net/api/v1/links/{id}

请求示例:

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

https://go.f27.net/api/v1/links/{id}

请求示例:

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