前言

石墨文档 SDK 包含以下内容：

• 浏览器端运行资源（.js、.css 等）；
• 服务器端资源。

事前准备

浏览器端

石墨文档 SDK 浏览器端（简称 JS SDK，后同）部分需运行于指定的环境，并分为以下部分：

• 通用模块；
• 文档模块（简称文档 JS SDK，后同）；
• 表格模块（简称表格 JS SDK，后同）。

除通用模块外，其他模块可以按需加载，互不冲突。

运行环境

待补充。

服务器端

服务器端指石墨文档 SDK 运行在指定机器上的实例总称（后文统一以 SDK API 称呼），JS SDK 需搭配 SDK API 才可正常工作。

运行环境

待补充。

API 规范

API 入口

正式环境

https://platform.shimo.im/entry

测试环境

https://platform.shimodev.com/entry

• 测试环境和正式环境不互通，数据互相独立，不能迁移
• 测试环境仅供功能 / API 接入测试
• 测试环境数据不承诺保留，请勿提交重要数据

鉴权

SDK API 以 OAuth 2.0 协议为鉴权方式。详见鉴权认证。

通信格式

SDK API 以 JSON 为主要通信格式，如无特殊说明，所有请求均基于 Content-Type: application/json，请根据所使用的 HTTP 请求库添加对应的 header

术语

名称	说明
<SHIMO_API>	- 测试环境为：https://platform.shimodev.com/entry - 正式环境为：https://platform.shimo.im/entry - 私有部署视情况而定
<CLIENT_ID> 和 <CLIENT_SECRET>	为用于 API 认证用的凭证
<CLIENT_USER_ID>	为您内部系统标识用户的唯一 ID，一般为数字 ID、电子邮箱或手机号码
<ACCESS_TOKEN>	为您通过 <CLIENT_ID> 和 <CLIENT_SECRET> 申请的 Access Token
<GUID>	为石墨为创建的文档分配的唯一 ID，您需要独立保存该 GUID