获取用户水印信息
开发中GET
{endpoint_url}/users/{userId}/watermark在用户打开或者预览文档时,会尝试获取当前用户的水印信息用于在页面上展示,接入方可选择返回业务中相应信息作为水印字段信息,也可按照格式返回空,页面上将隐藏水印信息
请求参数
Path 参数
endpoint_url
string
必需
示例值:
{{ endpoint_url}}
userId
string
必需
Header 参数
X-Shimo-Token
string
必需
用于接入方对本次请求鉴权
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
watermarks
array[string]
必需
接入方返回的水印字段,以字符串数组的形式返回,每个字符串代表一行。返回空数组时,石墨编辑器将不会在编辑器上展示水印信息。
:::info 提示
由于水印字段目前使用字符串传递,目前未限制此字段长度,为了更好的水印体验,建议返回字段遵循如下规则:
字段数量
不超过3
个,即水印内容
不超过3
行每个字段
不超过20
个字,即水印单行
内容不超过20
字
若确实有需要,可按照自身需求调整行数
或单行字数
。
:::
示例
成功示例(返回自定义水印信息用于展示)
{
"watermarks": [
// 结果为字符串数组,按顺序每个单独字符串为一行显示
"张三",
"userid",
"XX团队-部门-子部门"
]
}
最后修改时间: 1 年前