链接

注意
专享
在请求API中，API密钥需要发送到Bearer key 获取API key.
列表

API接口:

GET 
http://yin.biz/api/v1/links

请求示例: 

curl --location --request GET 'http://yin.biz/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
按分组id筛选
domain
可选 integer
按域名id筛选
pixel
可选 integer
按像素 ID 过滤.
sort_by
可选 string
Sort by. 可选：Date created id, 点击 clicks, 标题 title, 自定义短链 alias, 链接 url 默认为：id.
sort
可选 string
排序. 可选：降序 desc, 升序 asc 默认为：desc.
per_page
可选 int
每页显示条数. 可选：10, 25, 50, 100 默认为：25.
示例

API接口:

GET 
http://yin.biz/api/v1/links/{id}

请求示例: 

curl --location --request GET 'http://yin.biz/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
POST接口缩短

API接口:

POST 
http://yin.biz/api/v1/links

请求示例: 

curl --location --request POST 'http://yin.biz/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
要集成在链接中的像素ID
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://yin.biz/api/v1/links/{id}

请求示例: 

curl --location --request PUT 'http://yin.biz/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
要集成在链接中的像素ID
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://yin.biz/api/v1/links/{id}

请求示例: 

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