石墨文档协同服务
专用API
【更新时间: 2024.03.26】
石墨文档协同服务，作为新一代云端 Office，具备丰富多样的产品应用。支持多人在线编辑，让协作更高效，同时还能实现多端同步共享，无论是在电脑端还是移动端，都能随时随地进行办公操作，极大提升工作便利性。
|
服务星级：6星
浏览次数
16
采购人数
0
试用次数
0
SLA: N/A
响应: N/A
适用于个人&企业
收藏
×
完成
取消
×
书签名称
确定
|
相似API
Notion
49
通过Notion API，开发者可以创建、读取、更新和删除Notion数据库中的页面、块、属性等信息，以及执行其他相关操作。
Microsoft Graph服务-工作助手
16
Microsoft Graph 是 Microsoft 365 中数据和智能的门户。它提供了一个统一的可编程性模型，可用于访问 Microsoft 365、Windows 和企业移动性 + 安全性中的大量数据。使用通过 Microsoft Graph 访问的大量数据，为与数百万用户交互的组织和使用者构建应用。
CRM服务-Zoho
27
Zoho CRM REST API 允许开发人员访问 Zoho CRM 中的数据并与之交互。此 API 提供了将 Zoho CRM 数据集成到第三方应用程序、自动化工作流程和构建自定义应用程序的功能。
- 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 相关事件 | 由接入商选择性处理需要关心的事件数据。如当有人对评论、讨论、提及等进行操作时，部分操作会触发此事件 |
什么是石墨文档协同服务？
由服务使用方的应用程序发起，以Restful风格为主、通过公网HTTP协议调用石墨文档协同服务，从而实现程序的自动化交互，提高服务效率。
相关资料
一张表格管项目、管销售，这个机器人集团把协作“卷”出新高度
石墨文档客户案例
日期：2024年03月26日
产品问答
?
文档中引用的第三方文件是存在石墨服务器还是接入方服务器？
引用的第三方文件在第三方服务器。
?
文档中附件上传的文件是存在石墨服务器还是接入方服务器？
附件上传的文件在石墨服务器。
关于我们
武汉初心科技有限公司
企业
武汉初心科技有限公司是一家致力于提供云端办公软件的高科技企业，旗下产品石墨文档是一款面向未来的多人实时协作办公平台。公司以创新技术为核心，提供文档、表格、幻灯片等九大办公套件，以及企业级云盘服务，满足不同行业和企业的办公需求。石墨文档以其高效的协作能力、强大的数据管理和安全可控的特性，服务于85万家知名企业，覆盖互联网、教育、金融等多个行业，成为企业数字资产流转和项目管理的重要工具。
联系信息
API接口列表
依赖服务
产品问答
?
文档中引用的第三方文件是存在石墨服务器还是接入方服务器？
引用的第三方文件在第三方服务器。
?
文档中附件上传的文件是存在石墨服务器还是接入方服务器？
附件上传的文件在石墨服务器。
关于我们
武汉初心科技有限公司
企业
武汉初心科技有限公司是一家致力于提供云端办公软件的高科技企业，旗下产品石墨文档是一款面向未来的多人实时协作办公平台。公司以创新技术为核心，提供文档、表格、幻灯片等九大办公套件，以及企业级云盘服务，满足不同行业和企业的办公需求。石墨文档以其高效的协作能力、强大的数据管理和安全可控的特性，服务于85万家知名企业，覆盖互联网、教育、金融等多个行业，成为企业数字资产流转和项目管理的重要工具。
联系信息
