石墨文档协同服务
专用API
【更新时间: 2024.03.26】
石墨文档协同服务，作为新一代云端 Office，具备丰富多样的产品应用。支持多人在线编辑，让协作更高效，同时还能实现多端同步共享，无论是在电脑端还是移动端，都能随时随地进行办公操作，极大提升工作便利性。
|
服务星级：6星
浏览次数
26
采购人数
0
试用次数
0
SLA: N/A
响应: N/A
适用于个人&企业
收藏
×
完成
取消
×
书签名称
确定
|
- API详情
- 常见 FAQ
- 关于我们
- 相关推荐
什么是石墨文档协同服务?
服务详情
9大产品套件
石墨由文档、表格、幻灯片等八个常用办公套件加上企业级云盘组成， 致力于打造面向未来的多人实时协作「云端 Office」
应用场景
核心优势
接口清单
| 接口 | 接口用途 | 说明 |
|---|---|---|
| GET /files | 获取当前用户的文件列表 | 添加跨表格公式、合并工作表等选择用户最近使用的文件列表会请求此接口 |
| GET /files/{fileId} | 获取文件元信息-协同文档 | 获取基本信息、权限等，创建、导入、编辑会请求此接口 |
| GET /files/{fileId} | 获取文件元信息-文件预览 | 获取基本信息、下载地址，预览文件时会请求此接口 |
| GET /files/{fileId}/collaborators | 获取当前的协作用户 | 用于获取此协作文件的协作者（接入方可自己控制哪些用户为协作者）用户列表信息，如评论实时同步给其他用户时用于获取协作者列表发送评论事件 |
| POST /files/{fileId}/url | 获取接入方指定文件的完整访问地址 | 在文件中 @ 其他文件时，在将此文件导出后的文件中会保留一个石墨 SDK 的跳转链接地址，打开链接时，会通过此接口获取当前完整的接入方访问链接，获取后会重定向到接入方文件地址 |
| GET /admin/files/{fileId} | 获取文件元信息-协同文档自动任务 | 自动任务获取基本信息（目前只有跨表格引用任务）时会请求此接口 |
| GET /admin/files/{fileId}/by-user-id | 根据指定用户获取文件元信息-协同文档 | 石墨 SDK 需要主动获取文件基本信息（目前只有跨表格引用场景）时会请求此接口 |
| GET /users/current/info | 获取当前用户信息 | 获取当前用户的 ID、名称、头像图片地址等信息，创建、编辑、导入时需使用此接口获取用户身份信息 |
| GET /users/current/team | 获取当前用户所在团队信息 | 获取当前用户所在团队的 ID、名称、团队成员总数 |
| GET /users/{userId} | 获取指定用户信息 | 提供用户的基本信息，ID、名称、头像图片地址等，在获取协作场景下的指定用户信息时会请求此接口 |
| GET /users/{userId}/watermark | 获取用户水印信息 | 获取指定用户的水印信息，可根据自身业务系统需要获取返回需要的水印字段或返回空 |
| GET /users/{userId}/department-paths | 获取用户部门路径 | 获取指定用户的部门路径，可根据自身业务系统需要获取返回需要的部门路径或返回空 |
| POST /users/batch/get | 批量获取用户信息 | 提供多个指定用户的信息，ID、名称、头像图片地址等。如多人协作时，侧边栏历史展示时需要展示多个用户的相关信息，此时会请求此接口 |
| GET /teams/{teamId}/members | 获取团队下的成员列表 | 获取指定团队的成员列表，根据分页信息查询列表结果 |
| GET /departments/{departmentId} | 获取部门信息 | 获取指定部门的信息，包括部门 ID、名称、部门成员总数 |
| GET /departments/{departmentId}/children | 获取部门的下级部门节点 | 获取指定部门的下级部门节点，包括部门信息 ID、名称、部门成员总数 |
| GET /departments/{departmentId}/members | 获取部门下的成员分页列表 | 获取指定部门下的成员分页列表，获取当前分页的用户信息列表以及总成员数 |
| GET /search/users/recent | 获取与文件相关的用户列表 | 用于在文件中输入 @ 时，为展示下拉菜单，选择提及的用户，由于此时没有输入关键字，接入方可根据自己系统情况返回，如：和当前用户最相关的用户列表、和当前文件最相关的用户列表、或返回空数组 |
| GET /search/files/recent | 获取与文件相关的文件列表 | 用于在文件中输入 @ 时，展示下拉菜单，选择提及的文件，由于此时没有输入关键字，接入方可根据自己系统情况返回，如：和当前用户最相关的文件列表、和当前文件最相关的文件列表、或返回空数组 |
| POST /search | 根据关键字搜索文件或用户 | 用于输入 @ 时，如需要根据关键字，通过请求接入方系统返回对应的文件列表、用户列表，如不需要可将对应字段返回空数组。表格锁定添加人员时涉及此接口 |
| POST /events | 推送石墨 SDK 相关事件 | 由接入商选择性处理需要关心的事件数据。如当有人对评论、讨论、提及等进行操作时，部分操作会触发此事件 |
什么是石墨文档协同服务接口？
Shimo（石墨文档）是一个 在线文档协作平台，类似于 Google Docs，旨在提供文档的 实时编辑、存储和共享 功能，支持多人协作编辑、团队协作与项目管理。Shimo 允许用户创建和编辑各种类型的文档，如文字文档、表格、演示文稿等。它提供了云端存储和与他人协作的功能，可以用于个人使用或团队工作。
主要特点：
-
实时协作：多个用户可以同时编辑同一个文档，支持文档的版本控制和实时更新，适合团队合作和远程办公。
-
跨平台支持：Shimo 提供了 网页版、桌面应用（Windows 和 Mac）、手机应用（iOS 和 Android），方便用户在不同设备上使用。
-
文档编辑功能：支持丰富的文档格式，如 文字处理、表格、演示文稿，并提供基本的排版、编辑、计算和图表等功能。
-
权限和共享：用户可以对文档进行权限管理，控制谁可以查看或编辑文档，适合团队合作和信息共享。
-
云端存储：Shimo 提供文档的云端存储服务，确保文档安全且便于随时随地访问。
-
集成与协作：除了基本的文档编辑，Shimo 还集成了一些 项目管理工具 和 团队协作功能，便于任务分配和项目进度跟踪。
典型用户：
- 个人用户：适合需要云端文档管理和与他人协作的人。
- 团队和企业：适合团队共同编辑和管理文档、表格等，支持远程工作和项目管理。
Shimo 的定位是提供一个 简洁、高效、便捷的文档协作平台，能够提高团队的工作效率，特别是在多人协作和文档管理方面。
Shimo（石墨文档）是一个 在线文档协作平台，类似于 Google Docs，旨在提供文档的 实时编辑、存储和共享 功能，支持多人协作编辑、团队协作与项目管理。Shimo 允许用户创建和编辑各种类型的文档，如文字文档、表格、演示文稿等。它提供了云端存储和与他人协作的功能，可以用于个人使用或团队工作。
主要特点：
-
实时协作：多个用户可以同时编辑同一个文档，支持文档的版本控制和实时更新，适合团队合作和远程办公。
-
跨平台支持：Shimo 提供了 网页版、桌面应用（Windows 和 Mac）、手机应用（iOS 和 Android），方便用户在不同设备上使用。
-
文档编辑功能：支持丰富的文档格式，如 文字处理、表格、演示文稿，并提供基本的排版、编辑、计算和图表等功能。
-
权限和共享：用户可以对文档进行权限管理，控制谁可以查看或编辑文档，适合团队合作和信息共享。
-
云端存储：Shimo 提供文档的云端存储服务，确保文档安全且便于随时随地访问。
-
集成与协作：除了基本的文档编辑，Shimo 还集成了一些 项目管理工具 和 团队协作功能，便于任务分配和项目进度跟踪。
典型用户：
- 个人用户：适合需要云端文档管理和与他人协作的人。
- 团队和企业：适合团队共同编辑和管理文档、表格等，支持远程工作和项目管理。
Shimo 的定位是提供一个 简洁、高效、便捷的文档协作平台，能够提高团队的工作效率，特别是在多人协作和文档管理方面。
