链接 - 开发人员 - 快短网址

笔记

专家级别

API密钥应在请求的授权标题中作为携带者令牌发送。获取您的API key.

列表

API端点:

GET

http://kdwz.cn/api/v1/links

请求示例:

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

范围

类型

描述

search

可选的 string

搜索查询。

search_by

可选的 string

搜索. 可能的值是标题的title, 短链的alias, URL的url。默认值为titles。

status

可选的 integer

按状态过滤。可能的值是全部的0, 激活的1, 已到期的2, 禁用的3。默认值为0s。

space_id

可选的 integer

按空格ID过滤。

domain_id

可选的 integer

通过域ID过滤。

pixel_id

可选的 integer

通过像素ID过滤。

sort_by

可选的 string

排序方式. 可能的值是创建日期的id, 点击次数的clicks, 标题的title, 短链的alias, URL的url。默认值为ids。

sort

可选的 string

种类. 可能的值是下降的desc, 上升的asc。默认值为descs。

per_page

可选的 integer

每页结果. 可能的值是10, 25, 50, 100。默认值为25s。

显示

API端点:

GET

http://kdwz.cn/api/v1/links/{id}

请求示例:

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

店铺

API端点:

POST

http://kdwz.cn/api/v1/links

请求示例:

curl --location --request POST 'http://kdwz.cn/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。默认值为0s。

privacy

可选的 integer

链接统计是否公开。可能的值是公开的0, 私人的1, 密码的2。默认值为0s。

privacy_password

可选的 string

统计页面的密码。仅与字段设置为2。

expiration_url

可选的 string

链接过期后，将重定向用户的链接。

expiration_date

可选的 string

链接到期日期格式。

expiration_time

可选的 string

链接到期时间格式。

expiration_clicks

可选的 integer

链接应过期的点击次数。

target_type

可选的 integer

目标的类型。可能的值是None的0, 地理的1, 平台的2, 轮换的4。

country[index][key]

可选的 string

目标国家的代码。该代码必须以标准标准为标准。

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

目标语言的代码。该代码必须以标准标准为标准。

language[index][value]

可选的 string

用户将重定向到的链接。

rotation[index][value]

可选的 string

用户将重定向到的链接。

更新

API端点:

PUT PATCH

http://kdwz.cn/api/v1/links/{id}

请求示例:

curl --location --request PUT 'http://kdwz.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_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

统计页面的密码。仅与字段设置为2。

expiration_url

可选的 string

链接过期后，将重定向用户的链接。

expiration_date

可选的 string

链接到期日期格式。

expiration_time

可选的 string

链接到期时间格式。

expiration_clicks

可选的 integer

链接应过期的点击次数。

target_type

可选的 integer

目标的类型。可能的值是None的0, 地理的1, 平台的2, 轮换的4。

country[index][key]

可选的 string

目标国家的代码。该代码必须以标准标准为标准。

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

目标语言的代码。该代码必须以标准标准为标准。

language[index][value]

可选的 string

用户将重定向到的链接。

rotation[index][value]

可选的 string

用户将重定向到的链接。

删除

API端点:

DELETE

http://kdwz.cn/api/v1/links/{id}

请求示例:

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