回收站

接入前提

获取调用 API 所需的 token 请参考 API 鉴权

回收站只处理已删除作品，不参与 PPT 生成。还原和彻底删除都改变作品状态，接入方应在自己的页面明确区分这两个操作。

操作	说明
已删除列表	查询当前用户已删除但仍可处理的作品
作品还原	将已删除作品恢复到作品列表
彻底删除	永久删除作品，接入方需要在业务上提示用户风险

使用边界

目标	是否使用回收站接口
管理已删除作品	是
查询正常作品列表	否，使用 作品列表
导出作品	否，使用 作品导出

回收站页面既要能查到已删除作品，也要在还原和彻底删除前让用户看清操作后果。

已删除列表

接口行为

接口描述	此接口返回第三方用户已删除进入回收站的作品列表
接口地址	/api/design/del/list	请求方式	GET
权限校验	是	请求参数	json

请求参数

请求示例

curl --location --request GET 'https://co.aippt.cn/api/design/del/list?page=1&page_size=10' \
--header 'x-api-key: <apiKey>' \
--header 'x-channel: <channel>' \
--header 'x-token: <token>'

响应内容

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 3,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 18,
                "user_id": 1,
                "name": "重命名测试",
                "cover_url": "https://aippt-domestic.aippt.com/aippt-api-server/personal/image/0/1/20231030192402ipkzfou.jpeg",
                "size": "960x540",
                "canvas_url": "https://aippt-domestic.aippt.com/aippt-api-server/personal/other/0/1/20231031103706nypfzgk.json",
                "ai_data": "https://aippt-domestic.aippt.com/aippt-api-server/personal/other/0/1/20231030192403hrjlloy.json",
                "storage_time": "2023-10-31 10:37:07",
                "delete_time": "2023-11-01 15:40:18",
                "auto_delete_time": 30,
                "created_at": "2023-10-31 10:02:01",
                "updated_at": "2023-11-01 15:40:19"
            }
        ]
    },
    "msg": "ok"
}

作品还原

接口行为

接口描述	第三方用户已删除作品还原
接口地址	/api/design/revert	请求方式	POST
权限校验	是	请求参数	json

请求参数

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/revert' \
--header 'x-api-key: <apiKey>' \
--header 'x-channel: <channel>' \
--header 'x-token: <token>' \
--data-urlencode 'user_design_id=<designId>'

响应内容

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

彻底删除

接口行为

接口描述	第三方用户已删除作品彻底删除
接口地址	/api/design/clear	请求方式	POST
权限校验	是	请求参数	json

请求参数

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/clear' \
--header 'x-api-key: <apiKey>' \
--header 'x-channel: <channel>' \
--header 'x-token: <token>' \
--data-urlencode 'user_design_id=<designId>'

响应内容

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}