Skip to main content
2023-12-13 02:52 更新Version: latest

概述

在对接石墨文档中台时,接入方需要提供一系列 HTTP 接口供石墨方“回调”,才能正常使用文档中台的功能。

什么是“回调”?

石墨文档中台专注于对文档本身的预览、编辑以及协同功能,对接入方系统中的用户信息、组织架构、文件权限等方面都没有入侵,这意味着石墨文档中台不会存储这些数据。

因此,石墨文档中台需要从接入方的系统中获取相关数据,获取数据的方式为调用 HTTP 接口,这一过程我们称之为“回调”。

“回调接口”的详细定义见本章后续内容。

回调凭证类型

请求回调接口存在不同的触发场景,因此存在不同的凭证类型,通过回调请求的 HTTP Header 指定 X-Shimo-Credential-Type

已知的凭证类型:

  • X-Shimo-Credential-Type == 0,此类型通常是由用户的操作行为触发,比如打开页面、编辑文件等,请求会通过 HTTP Header X-Shimo-Token 携带用户在浏览器操作时接入方颁发的 token
  • X-Shimo-Credential-Type == 3, 此类型通常由石墨文档中台主动触发,如跨表格引用的更新等,请求会通过 HTTP Header X-Shimo-Signature 根据接入方当前的 appId secret 主动签名后供接入方回调进行校验,确认此请求是否来自石墨文档中台。