push文档开放接口文档 V1.0

点击展开版本更新日志

1.0 接口更新日期：2026-08-11
首次发布：文档列表、创建、内容读写、发布、重命名、删除、分享设置

1.0.1 文档更新日期：2026-08-13
开放接口路径 /open/document 调整为 /open/doc

点击查看目录

文档说明

    push文档是 pushplus 提供的在线文档能力，基于 Tiptap 富文本。开放接口用于通过程序管理自己的文档（创建、写入内容、发布、分享等），鉴权方式与 pushplus 开放接口 一致：先获取 AccessKey，再在请求头携带 access-key。

    AccessKey 的申请、安全 IP、secretKey 配置与主站开放接口相同，请先阅读 开放接口文档 - 获取AccessKey。

    文档开放接口的基础地址为：

https://www.pushplus.plus/push/api

分享页地址形如：https://www.pushplus.plus/push/doc/{docCode}（接口返回的 shareUrl 字段）。

    可通过 content / saveContent / publish 完成「写内容 → 发布到分享页」。

鉴权说明

调用本章节接口时，需在 HTTP Header 中携带：

Header 名称是否必填说明
access-key是通过主站 getAccessKey 接口获取的令牌

也可兼容 Header / Cookie 中的 pushToken（浏览器登录态），但程序调用请统一使用 access-key。

获取 AccessKey 示例（与主站相同）：

  • 请求地址：https://www.pushplus.plus/api/common/openApi/getAccessKey
  • 请求方式：POST
  • 请求参数：
{
  "token": "d90******c20",
  "secretKey": "qLc******gdk"
}

通用响应格式

{
  "code": 200,
  "msg": "请求成功",
  "data": {}
}
字段类型说明
code数字业务状态码，200 表示成功
msg字符串提示信息
data对象业务数据；无业务数据时该字段可能不返回

类型与状态说明

sharePerm / shareLogin

字段取值说明
sharePerm0关闭分享
sharePerm1开启分享（仅可查看）
shareLogin0免登录可打开分享页
shareLogin1需登录后打开分享页

perm

字段取值说明
perm1当前用户可查看
perm2当前用户可编辑

开放接口查询的是「我的文档」，因此列表与管理类接口返回的 perm 一般为 2。

草稿与发布

文档采用「草稿 / 发布快照」模型：

  1. saveContent 只写入草稿，不影响已对外分享的内容
  2. publish 将草稿同步为分享页快照
  3. 开启分享且从未发布过时，系统会自动用当前草稿生成首版快照
字段类型说明
published布尔是否已发布过；true 表示分享页已有发布快照
publishDirty布尔草稿与发布快照是否不一致；保存草稿后未重新发布时为 true
publishTime字符串最近发布时间；从未发布过时不返回该字段

一. 我的文档分页

1. 使用说明

分页查询当前用户的文档列表，支持按关键词、是否已开启分享筛选。列表不返回正文内容。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/list
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
Content-Type: application/json
  • 请求参数：
{
  "pageNum": 1,
  "pageSize": 10,
  "keyword": "工作同步",
  "shareEnabled": true
}
  • 请求参数说明
参数名称是否必填默认值说明
pageNum否1页码，从 1 开始
pageSize否10每页条数，最大 50
keyword否无按标题关键词搜索
shareEnabled否无true 时仅返回已开启分享的文档；不传则全部
  • 响应内容
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "docCode": "Ab3xY7kP",
        "shareUrl": "https://www.pushplus.plus/push/doc/Ab3xY7kP",
        "title": "本周工作同步",
        "sharePerm": 1,
        "shareLogin": 1,
        "perm": 2,
        "published": true,
        "publishTime": "2026-08-11 10:00:00",
        "createTime": "2026-08-10 09:00:00",
        "updateTime": "2026-08-11 10:00:00"
      }
    ],
    "total": 1,
    "pageNum": 1,
    "pageSize": 10
  }
}
  • 响应字段说明
参数名称类型说明
list列表文档列表
total数字总记录数
pageNum数字当前页
pageSize数字每页条数
list[].docCode字符串文档分享码
list[].shareUrl字符串分享链接
list[].title字符串标题
list[].sharePerm数字分享权限：0关闭 / 1开启（仅可查看）
list[].shareLogin数字分享是否需登录：0免登录 / 1需登录
list[].perm数字当前用户权限：1可查看 / 2可编辑
list[].published布尔是否已发布过
list[].publishTime字符串最近发布时间；从未发布过时不返回
list[].createTime字符串创建时间
list[].updateTime字符串更新时间

二. 创建文档

1. 使用说明

创建空白文档。创建后默认关闭分享；可通过「保存内容」「发布」写入并对外同步。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/create
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
Content-Type: application/json
  • 请求参数：
{
  "title": "本周工作同步"
}
  • 请求参数说明
参数名称是否必填默认值说明
title是无标题，最长 100 字
  • 响应内容
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "docCode": "Ab3xY7kP",
    "shareUrl": "https://www.pushplus.plus/push/doc/Ab3xY7kP",
    "title": "本周工作同步",
    "sharePerm": 0,
    "shareLogin": 1,
    "perm": 2,
    "published": false,
    "publishDirty": false,
    "createTime": "2026-08-11 12:00:00",
    "updateTime": "2026-08-11 12:00:00"
  }
}
  • 响应字段说明
参数名称类型说明
docCode字符串文档分享码
shareUrl字符串分享链接
title字符串标题
sharePerm数字分享权限：0关闭 / 1开启（仅可查看）；新建默认为 0
shareLogin数字分享是否需登录：0免登录 / 1需登录；新建默认为 1
perm数字当前用户权限：1可查看 / 2可编辑
published布尔是否已发布过；新建为 false
publishDirty布尔草稿与发布快照是否不一致；新建为 false
publishTime字符串最近发布时间；从未发布过时不返回
createTime字符串创建时间
updateTime字符串更新时间

三. 获取文档内容

1. 使用说明

按分享码获取当前用户自己的文档元信息与草稿正文（HTML）。仅能读取自己创建的文档。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/content
  • 请求方式：GET
  • 请求 Header：
access-key: d7b******62f
  • 请求参数（Query）：
参数名称是否必填默认值说明
docCode是无文档分享码
  • 响应内容
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "docCode": "Ab3xY7kP",
    "shareUrl": "https://www.pushplus.plus/push/doc/Ab3xY7kP",
    "title": "本周工作同步",
    "sharePerm": 1,
    "shareLogin": 1,
    "perm": 2,
    "published": true,
    "publishDirty": true,
    "publishTime": "2026-08-11 10:00:00",
    "createTime": "2026-08-10 09:00:00",
    "updateTime": "2026-08-11 12:30:00",
    "content": "<h1>本周工作同步</h1><p>需求评审与排期确认。</p>"
  }
}
  • 响应字段说明
参数名称类型说明
docCode字符串文档分享码
shareUrl字符串分享链接
title字符串标题
sharePerm数字分享权限：0关闭 / 1开启（仅可查看）
shareLogin数字分享是否需登录：0免登录 / 1需登录
perm数字当前用户权限：1可查看 / 2可编辑
published布尔是否已发布过
publishDirty布尔草稿与发布快照是否不一致
publishTime字符串最近发布时间；从未发布过时不返回
createTime字符串创建时间
updateTime字符串更新时间
content字符串HTML 草稿正文

四. 保存文档内容

1. 使用说明

保存文档草稿 HTML。保存后不影响分享页，需再调用「发布文档」才会同步对外内容。仅所有者可保存。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/saveContent
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
Content-Type: application/json
  • 请求参数：
{
  "docCode": "Ab3xY7kP",
  "content": "<h1>本周工作同步</h1><ul><li>需求评审与排期确认</li><li>两个新功能已上线</li></ul>"
}
  • 请求参数说明
参数名称是否必填默认值说明
docCode是无文档分享码
content是无HTML 内容；允许空文档（后端归一化为空段落），最长约 2MB
  • 响应内容
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "docCode": "Ab3xY7kP",
    "shareUrl": "https://www.pushplus.plus/push/doc/Ab3xY7kP",
    "title": "本周工作同步",
    "sharePerm": 1,
    "shareLogin": 1,
    "perm": 2,
    "published": true,
    "publishDirty": true,
    "publishTime": "2026-08-11 10:00:00",
    "createTime": "2026-08-10 09:00:00",
    "updateTime": "2026-08-11 12:30:00"
  }
}
  • 响应字段说明
参数名称类型说明
docCode字符串文档分享码
shareUrl字符串分享链接
title字符串标题
sharePerm数字分享权限：0关闭 / 1开启（仅可查看）
shareLogin数字分享是否需登录：0免登录 / 1需登录
perm数字当前用户权限：1可查看 / 2可编辑
published布尔是否已发布过
publishDirty布尔草稿与发布快照是否不一致；已发布过再保存草稿后一般为 true
publishTime字符串最近发布时间；从未发布过时不返回
createTime字符串创建时间
updateTime字符串更新时间

五. 发布文档

1. 使用说明

将草稿同步为分享页快照。发布成功后 published 为 true，publishDirty 为 false，并写入 publishTime。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/publish
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
  • 请求参数（Query）：
参数名称是否必填默认值说明
docCode是无文档分享码
  • 响应内容
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "docCode": "Ab3xY7kP",
    "shareUrl": "https://www.pushplus.plus/push/doc/Ab3xY7kP",
    "title": "本周工作同步",
    "sharePerm": 1,
    "shareLogin": 1,
    "perm": 2,
    "published": true,
    "publishDirty": false,
    "publishTime": "2026-08-11 12:35:00",
    "createTime": "2026-08-10 09:00:00",
    "updateTime": "2026-08-11 12:35:00"
  }
}
  • 响应字段说明
参数名称类型说明
docCode字符串文档分享码
shareUrl字符串分享链接
title字符串标题
sharePerm数字分享权限：0关闭 / 1开启（仅可查看）
shareLogin数字分享是否需登录：0免登录 / 1需登录
perm数字当前用户权限：1可查看 / 2可编辑
published布尔是否已发布过；发布后为 true
publishDirty布尔草稿与发布快照是否不一致；发布后为 false
publishTime字符串最近发布时间
createTime字符串创建时间
updateTime字符串更新时间

六. 重命名

1. 使用说明

修改文档标题，仅所有者可操作。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/rename
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
Content-Type: application/json
  • 请求参数：
{
  "docCode": "Ab3xY7kP",
  "title": "本周工作同步（已更新）"
}
  • 请求参数说明
参数名称是否必填默认值说明
docCode是无文档分享码
title是无新标题，最长 100 字
  • 响应内容
{
  "code": 200,
  "msg": "请求成功"
}

七. 删除文档

1. 使用说明

删除文档（逻辑删除），仅所有者可操作。删除后分享链接不可访问。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/delete
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
  • 请求参数（Query）：
参数名称是否必填默认值说明
docCode是无文档分享码
  • 响应内容
{
  "code": 200,
  "msg": "请求成功"
}

八. 更新分享设置

1. 使用说明

开启或关闭文档分享，并可设置打开分享页是否需要登录。仅支持「关闭 / 开启仅查看」，不再提供可编辑分享。

开启分享且从未发布过时，会自动用当前草稿生成首版快照。

2. 接口调用说明

  • 请求地址：https://www.pushplus.plus/push/api/open/doc/updateShare
  • 请求方式：POST
  • 请求 Header：
access-key: d7b******62f
Content-Type: application/json
  • 请求参数：
{
  "docCode": "Ab3xY7kP",
  "sharePerm": 1,
  "shareLogin": 1
}
  • 请求参数说明
参数名称是否必填默认值说明
docCode是无文档分享码
sharePerm是无0关闭 / 1开启（仅可查看）
shareLogin否沿用原值0免登录 / 1需登录；开启分享时缺省为需登录
  • 响应内容
{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "docCode": "Ab3xY7kP",
    "shareUrl": "https://www.pushplus.plus/push/doc/Ab3xY7kP",
    "title": "本周工作同步",
    "sharePerm": 1,
    "shareLogin": 1,
    "perm": 2,
    "published": true,
    "publishDirty": false,
    "publishTime": "2026-08-11 12:35:00",
    "createTime": "2026-08-10 09:00:00",
    "updateTime": "2026-08-11 12:40:00"
  }
}
  • 响应字段说明
参数名称类型说明
docCode字符串文档分享码
shareUrl字符串分享链接
title字符串标题
sharePerm数字分享权限：0关闭 / 1开启（仅可查看）
shareLogin数字分享是否需登录：0免登录 / 1需登录
perm数字当前用户权限：1可查看 / 2可编辑
published布尔是否已发布过
publishDirty布尔草稿与发布快照是否不一致
publishTime字符串最近发布时间；从未发布过时不返回
createTime字符串创建时间
updateTime字符串更新时间

典型调用流程

1. getAccessKey
2. create（创建空白文档）
3. saveContent（写入 HTML 草稿）
4. updateShare（开启分享，可选）
5. publish（同步到分享页）
更新时间: