开发工具

文件内容更新

开发中

POST

{endpoint_url}/events

在文件有用户进行修改并被服务器处理成功后，将会触发此事件。

请求参数

Path 参数

endpoint_url

string

必需

示例值:

Header 参数

X-Shimo-Credential-Type

string

必需

无法提供 token 的回调凭证类型

X-Shimo-Sdk-Event

string

必需

用于识别具体的事件类型

示例值:

FileContent

X-Shimo-Signature

string

必需

当石墨无法提供接入方 token 时，使用接入方对应 appId, secret 主动生成 signature 用于回调接口校验

Body 参数application/json

kind

string

必需

type

string

必需

action

string

必需

fileId

string

接入方文件 ID

必需

userId

string

接入方用户 ID

必需

fileContent

object

必需

version

integer

必需

此事件发生时产生的新版本

timestamp

integer

此事件产生的时间

必需

示例

{
  "kind": "fileContent",
  "type": "fileContent",
  "action": "update",
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "fileContent": {
    "version": 2 // 此事件发生时产生的新版本
  },
  "timestamp": 1635732089224 // 此事件产生的时间
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/events' \
--header 'X-Shimo-Credential-Type;' \
--header 'X-Shimo-Sdk-Event: FileContent' \
--header 'X-Shimo-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "kind": "fileContent",
  "type": "fileContent",
  "action": "update",
  "fileId": "file1", // 接入方文件 ID
  "userId": "user1", // 接入方用户 ID
  "fileContent": {
    "version": 2 // 此事件发生时产生的新版本
  },
  "timestamp": 1635732089224 // 此事件产生的时间
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}

删除

文档协作者协同状态变化