Skip to content

分享管理API接口 ​

管理分享分享链接

获取分享列表 ​

http
GET /openapi/share

响应:Pagination<Share>

查询参数:

字段名可空说明
current否分页页码
pageSize否每页数量,最大100
keyword是模糊搜索关键字
code是后缀
type是share_link普通分享 tmp_link兑换链接
account_type是状态值,参考Share.account_type

获取分享详情 ​

http
GET /openapi/share/:id

路径参数:id 分享ID

响应:Share

添加分享 ​

http
POST /openapi/share

请求体参数:

字段名类型可空说明
codestring否链接后缀
account_typeall | point | tag否分享账号类型 all 全部账号, point 指定账号, tag 指定标签的账号
apple_tag_idnumber是关联的标签ID,account_type为tag时必填
account_idsnumber[]是分享的账号ID,account_type为point时必填
passwordstring是分享访问密码
max_account_countnumber是最大可分享账号数量
expire_timestring是分享过期时间,为空则永不过期
remarkstring是备注信息
apple_share_template_idnumber是使用的页面模板 ID

更新分享 ​

http
PUT /openapi/share/:id

路径参数:id 分享ID

请求体参数:

字段名类型可空说明
codestring否链接后缀
account_typeall | point | tag否分享账号类型 all 全部账号, point 指定账号, tag 指定标签的账号
apple_tag_idnumber是关联的标签ID,account_type为tag时必填
account_idsnumber[]是分享的账号ID,account_type为point时必填
passwordstring是分享访问密码
max_account_countnumber是最大可分享账号数量
expire_timestring是分享过期时间,为空则永不过期
remarkstring是备注信息
apple_share_template_idnumber是使用的页面模板 ID

删除分享 ​

http
DELETE /openapi/share/:id

路径参数:id 分享ID

示例

bash
curl -X DELETE http://localhost:3000/share/1