获取用户水印信息

开发中

GET

{endpoint_url}/users/{userId}/watermark

在用户打开或者预览文档时，会尝试获取当前用户的水印信息用于在页面上展示，接入方可选择返回业务中相应信息作为水印字段信息，也可按照格式返回空，页面上将隐藏水印信息

请求参数

Path 参数

endpoint_url

string

必需

示例值:

userId

string

必需

Header 参数

X-Shimo-Token

string

必需

用于接入方对本次请求鉴权

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

🟢200成功

application/json

Body

watermarks

array[string]

必需

接入方返回的水印字段，以字符串数组的形式返回，每个字符串代表一行。返回空数组时，石墨编辑器将不会在编辑器上展示水印信息。

提示

由于水印字段目前使用字符串传递，目前未限制此字段长度，为了更好的水印体验，建议返回字段遵循如下规则：

字段数量不超过 3 个，即水印内容不超过 3 行

每个字段不超过 20 个字，即水印单行内容不超过 20 字
若确实有需要，可按照自身需求调整行数或单行字数。

示例

成功示例（返回自定义水印信息用于展示）成功示例（返回空信息用于隐藏对应用户水印信息）

{
  "watermarks": [
    // 结果为字符串数组，按顺序每个单独字符串为一行显示
    "张三",
    "userid",
    "XX团队-部门-子部门"
  ]
}

修改于 2024-03-19 08:39:24