Skip to content
本页内容

回调接口说明

请求签名

金山发出回调请求,全部经过 WPS-2 签名算法签名。签名需要用到申请应用时拿到的 AppIdAppKey。签名法实现为,请求中会携带如下请求头,供判断请求的合法性:

错误码说明
Date
使用 RFC1123 时间格式的当前时间
Content-Type
目前固定为: application/json
Content-Md5
请求中 Body 内容的 md5 值十六进制表示方式, 小写。如果 Body 为空,改用 URI 计算, 例如: 原始请求为 GET https://foo.bar.com/baz/v3/3rd/files/123 则取 /baz/v3/3rd/files/123 计算
Authorization
格式为:wps-2:AppId:SH1值 其中 SHA1值 的计算方式为 SHA1( AppKey + Content-Md5 + Content-Type + Date) 十六进制表示方式, 小写

请求头

除签名头外,回调请求会携带如下三个业务数据头:

请求头必须类型说明
X-App-Id
string
当前请求所属的 AppIdURl 上的 _w_appid 值相同
X-WebOffice-Token
string
当前请求的用户凭证,即打开文件时通过 jssdk.setToken(...) 方法设置的 token
X-Request-Id
string
请求 Id,不保证唯一,方便定位问题

返回值格式

统一返回 application/json 格式数据

字段必须类型说明
code
integer
错误码,详见后续错误码定义,请求成功时,code0
message
string
错误说明,请求成功时,message 为空字符串
data
object
具体数据,如果请求失败,该字段可以不返回
  • 请求成功示例:
{
    "code": 0,
    "msg": "",
    "data": { "id": "404", "name": "Joe Doe" }
} 
  • 请求失败示例:
{
    "code": 40004,
    "message": "file not exists"
}

错误码定义

错误码说明
40002
用户凭证,即 x-weboffice-token 头, 无效
40003
用户操作权限不足
40004
文档不存在
40005
请求参数错误
40006
存储空间已满
40007
自定义错误,可以用来返回自定义错误信息
40008
文档名称冲突,例如重命名文档时
40009
文档版本不存在
40010
用户不存在
41001
文件未正确上传,例如保存文档时
50001
系提内错误导致的请求不能正常响应