链接 - 开发者

笔记

高级

API key 应该在请求时在Authorization请求头发送获取你的 API key.

列表

API端点:

GET

https://dwz.mk/api/v1/links

请求示例:

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

可选 integer

根据分组过滤

domain

可选 integer

根据域名过滤

pixel

可选 integer

根据像素筛选

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://dwz.mk/api/v1/links/{id}

请求示例:

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

保存

API端点:

POST

https://dwz.mk/api/v1/links

请求示例:

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

必须 integer

要保存的域名ID

alias

可选 string

链接别名

password

可选 string

链接密码

space

可选 integer

要保存的分组ID

pixels

可选 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://dwz.mk/api/v1/links/{id}

请求示例:

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

pixels

可选 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://dwz.mk/api/v1/links/{id}

请求示例:

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