石墨文檔協(xié)同服務(wù)
專用API
【更新時間: 2024.03.26】
石墨文檔協(xié)同服務(wù)，作為新一代云端 Office，具備豐富多樣的產(chǎn)品應(yīng)用。支持多人在線編輯，讓協(xié)作更高效，同時還能實現(xiàn)多端同步共享，無論是在電腦端還是移動端，都能隨時隨地進行辦公操作，極大提升工作便利性。
|
瀏覽次數(shù)
48
采購人數(shù)
0
試用次數(shù)
0
SLA: N/A
響應(yīng): N/A
適用于個人&企業(yè)
收藏
×
完成
取消
×
書簽名稱
確定
|
- API詳情
- 常見 FAQ
- 關(guān)于我們
- 相關(guān)推薦
什么是石墨文檔協(xié)同服務(wù)?
服務(wù)詳情
9大產(chǎn)品套件
石墨由文檔、表格、幻燈片等八個常用辦公套件加上企業(yè)級云盤組成， 致力于打造面向未來的多人實時協(xié)作「云端 Office」
應(yīng)用場景
核心優(yōu)勢
接口清單
| 接口 | 接口用途 | 說明 |
|---|---|---|
| GET /files | 獲取當前用戶的文件列表 | 添加跨表格公式、合并工作表等選擇用戶最近使用的文件列表會請求此接口 |
| GET /files/{fileId} | 獲取文件元信息-協(xié)同文檔 | 獲取基本信息、權(quán)限等，創(chuàng)建、導(dǎo)入、編輯會請求此接口 |
| GET /files/{fileId} | 獲取文件元信息-文件預(yù)覽 | 獲取基本信息、下載地址，預(yù)覽文件時會請求此接口 |
| GET /files/{fileId}/collaborators | 獲取當前的協(xié)作用戶 | 用于獲取此協(xié)作文件的協(xié)作者（接入方可自己控制哪些用戶為協(xié)作者）用戶列表信息，如評論實時同步給其他用戶時用于獲取協(xié)作者列表發(fā)送評論事件 |
| POST /files/{fileId}/url | 獲取接入方指定文件的完整訪問地址 | 在文件中 @ 其他文件時，在將此文件導(dǎo)出后的文件中會保留一個石墨 SDK 的跳轉(zhuǎn)鏈接地址，打開鏈接時，會通過此接口獲取當前完整的接入方訪問鏈接，獲取后會重定向到接入方文件地址 |
| GET /admin/files/{fileId} | 獲取文件元信息-協(xié)同文檔自動任務(wù) | 自動任務(wù)獲取基本信息（目前只有跨表格引用任務(wù)）時會請求此接口 |
| GET /admin/files/{fileId}/by-user-id | 根據(jù)指定用戶獲取文件元信息-協(xié)同文檔 | 石墨 SDK 需要主動獲取文件基本信息（目前只有跨表格引用場景）時會請求此接口 |
| GET /users/current/info | 獲取當前用戶信息 | 獲取當前用戶的 ID、名稱、頭像圖片地址等信息，創(chuàng)建、編輯、導(dǎo)入時需使用此接口獲取用戶身份信息 |
| GET /users/current/team | 獲取當前用戶所在團隊信息 | 獲取當前用戶所在團隊的 ID、名稱、團隊成員總數(shù) |
| GET /users/{userId} | 獲取指定用戶信息 | 提供用戶的基本信息，ID、名稱、頭像圖片地址等，在獲取協(xié)作場景下的指定用戶信息時會請求此接口 |
| GET /users/{userId}/watermark | 獲取用戶水印信息 | 獲取指定用戶的水印信息，可根據(jù)自身業(yè)務(wù)系統(tǒng)需要獲取返回需要的水印字段或返回空 |
| GET /users/{userId}/department-paths | 獲取用戶部門路徑 | 獲取指定用戶的部門路徑，可根據(jù)自身業(yè)務(wù)系統(tǒng)需要獲取返回需要的部門路徑或返回空 |
| POST /users/batch/get | 批量獲取用戶信息 | 提供多個指定用戶的信息，ID、名稱、頭像圖片地址等。如多人協(xié)作時，側(cè)邊欄歷史展示時需要展示多個用戶的相關(guān)信息，此時會請求此接口 |
| GET /teams/{teamId}/members | 獲取團隊下的成員列表 | 獲取指定團隊的成員列表，根據(jù)分頁信息查詢列表結(jié)果 |
| GET /departments/{departmentId} | 獲取部門信息 | 獲取指定部門的信息，包括部門 ID、名稱、部門成員總數(shù) |
| GET /departments/{departmentId}/children | 獲取部門的下級部門節(jié)點 | 獲取指定部門的下級部門節(jié)點，包括部門信息 ID、名稱、部門成員總數(shù) |
| GET /departments/{departmentId}/members | 獲取部門下的成員分頁列表 | 獲取指定部門下的成員分頁列表，獲取當前分頁的用戶信息列表以及總成員數(shù) |
| GET /search/users/recent | 獲取與文件相關(guān)的用戶列表 | 用于在文件中輸入 @ 時，為展示下拉菜單，選擇提及的用戶，由于此時沒有輸入關(guān)鍵字，接入方可根據(jù)自己系統(tǒng)情況返回，如：和當前用戶最相關(guān)的用戶列表、和當前文件最相關(guān)的用戶列表、或返回空數(shù)組 |
| GET /search/files/recent | 獲取與文件相關(guān)的文件列表 | 用于在文件中輸入 @ 時，展示下拉菜單，選擇提及的文件，由于此時沒有輸入關(guān)鍵字，接入方可根據(jù)自己系統(tǒng)情況返回，如：和當前用戶最相關(guān)的文件列表、和當前文件最相關(guān)的文件列表、或返回空數(shù)組 |
| POST /search | 根據(jù)關(guān)鍵字搜索文件或用戶 | 用于輸入 @ 時，如需要根據(jù)關(guān)鍵字，通過請求接入方系統(tǒng)返回對應(yīng)的文件列表、用戶列表，如不需要可將對應(yīng)字段返回空數(shù)組。表格鎖定添加人員時涉及此接口 |
| POST /events | 推送石墨 SDK 相關(guān)事件 | 由接入商選擇性處理需要關(guān)心的事件數(shù)據(jù)。如當有人對評論、討論、提及等進行操作時，部分操作會觸發(fā)此事件 |
什么是石墨文檔協(xié)同服務(wù)接口？
Shimo（石墨文檔）是一個 在線文檔協(xié)作平臺，類似于 Google Docs，旨在提供文檔的 實時編輯、存儲和共享 功能，支持多人協(xié)作編輯、團隊協(xié)作與項目管理。Shimo 允許用戶創(chuàng)建和編輯各種類型的文檔，如文字文檔、表格、演示文稿等。它提供了云端存儲和與他人協(xié)作的功能，可以用于個人使用或團隊工作。
主要特點：
-
實時協(xié)作：多個用戶可以同時編輯同一個文檔，支持文檔的版本控制和實時更新，適合團隊合作和遠程辦公。
-
跨平臺支持：Shimo 提供了 網(wǎng)頁版、桌面應(yīng)用（Windows 和 Mac）、手機應(yīng)用（iOS 和 Android），方便用戶在不同設(shè)備上使用。
-
文檔編輯功能：支持豐富的文檔格式，如 文字處理、表格、演示文稿，并提供基本的排版、編輯、計算和圖表等功能。
-
權(quán)限和共享：用戶可以對文檔進行權(quán)限管理，控制誰可以查看或編輯文檔，適合團隊合作和信息共享。
-
云端存儲：Shimo 提供文檔的云端存儲服務(wù)，確保文檔安全且便于隨時隨地訪問。
-
集成與協(xié)作：除了基本的文檔編輯，Shimo 還集成了一些 項目管理工具 和 團隊協(xié)作功能，便于任務(wù)分配和項目進度跟蹤。
典型用戶：
- 個人用戶：適合需要云端文檔管理和與他人協(xié)作的人。
- 團隊和企業(yè)：適合團隊共同編輯和管理文檔、表格等，支持遠程工作和項目管理。
Shimo 的定位是提供一個 簡潔、高效、便捷的文檔協(xié)作平臺，能夠提高團隊的工作效率，特別是在多人協(xié)作和文檔管理方面。
Shimo（石墨文檔）是一個 在線文檔協(xié)作平臺，類似于 Google Docs，旨在提供文檔的 實時編輯、存儲和共享 功能，支持多人協(xié)作編輯、團隊協(xié)作與項目管理。Shimo 允許用戶創(chuàng)建和編輯各種類型的文檔，如文字文檔、表格、演示文稿等。它提供了云端存儲和與他人協(xié)作的功能，可以用于個人使用或團隊工作。
主要特點：
-
實時協(xié)作：多個用戶可以同時編輯同一個文檔，支持文檔的版本控制和實時更新，適合團隊合作和遠程辦公。
-
跨平臺支持：Shimo 提供了 網(wǎng)頁版、桌面應(yīng)用（Windows 和 Mac）、手機應(yīng)用（iOS 和 Android），方便用戶在不同設(shè)備上使用。
-
文檔編輯功能：支持豐富的文檔格式，如 文字處理、表格、演示文稿，并提供基本的排版、編輯、計算和圖表等功能。
-
權(quán)限和共享：用戶可以對文檔進行權(quán)限管理，控制誰可以查看或編輯文檔，適合團隊合作和信息共享。
-
云端存儲：Shimo 提供文檔的云端存儲服務(wù)，確保文檔安全且便于隨時隨地訪問。
-
集成與協(xié)作：除了基本的文檔編輯，Shimo 還集成了一些 項目管理工具 和 團隊協(xié)作功能，便于任務(wù)分配和項目進度跟蹤。
典型用戶：
- 個人用戶：適合需要云端文檔管理和與他人協(xié)作的人。
- 團隊和企業(yè)：適合團隊共同編輯和管理文檔、表格等，支持遠程工作和項目管理。
Shimo 的定位是提供一個 簡潔、高效、便捷的文檔協(xié)作平臺，能夠提高團隊的工作效率，特別是在多人協(xié)作和文檔管理方面。
