公共参数 Request headers
... 2023-5-22 大约 2 分钟
# 公共参数 Request headers
回调请求会携带如下业务数据头：
注意： 为确保接入方的安全，实现回调接口时，接入方需要通过验证签名和令牌（token）来保证请求合法性。
| 字段 | 类型 | 必填 | 含义 |
|---|---|---|---|
| X-TDOCS-Open3rd-Token | string | 否 | 当前请求的用户的第三方系统凭证，WebSDK初始化时设置 |
| X-TDOCS-Trace-ID | string | 是 | 该请求的trace |
| X-TDOCS-APP-ID | string | 是 | 接入方在文档开放平台注册的APP ID |
| X-TDOCS-Nonce | string | 是 | 随机字符串 64 个字符以内 |
| X-TDOCS-TimeStamp | int64 | 是 | 发送请求时的Unix时间戳 |
| X-TDOCS-Signature | string | 是 | 请求签名 |
| Content-Type | string | 是 | 默认 application/json |
# 公共参数 Response
接入方应统一返回 application/json 格式的数据，相关字段和说明请参照下表。
| 字段 | 必须 | 类型 | 说明 |
|---|---|---|---|
| code | 是 | int32 | 错误码 |
| message | 否 | string | 错误说明 |
| data | 否 | struct | 具体业务数据，不同的接口返回不同的结构 |
# 签名计算方法
1）参与签名的参数有四个: X-TDOCS-Nonce, X-TDOCS-TimeStamp, X-TDOCS-APP-ID，APP-Secret
2）将这些参数使用URL键值对的格式 （即 key1=value1&key2=value2…）拼接成字符串str。 有两个注意点：1. 字段值采用原始值，不要进行URL转义；2. 必须严格按照如下格式拼接，不可变动字段顺序
String str = "app_id=X-TDOCS-APP-ID&app_secret=APP-Secret&nonce=X-TDOCS-Nonce×tamp=X-TDOCS-TimeStamp"
1
1
3）对str进行SHA1计算，单次签名在60分钟内有效期
String signature = SHA1(str)
1
1
# 错误码
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 10001 | 凭证 X-Open3rd-Token 无效或用户不存在 |
| 10002 | 请求参数错误 |
| 10003 | 系统内部错误 |
| 10004 | 文件不存在 |
| 10005 | 用户操作文件权限不足 |
| 10006 | 签名校验失败 |