信封中上传文档

1.描述: 信封中上传文档(form方式)

2.接口地址:

请求路径:/ws-rest/v1/users/{user-id}/envelopes/{envelope-id}/documents/form

请求头:采用HMAC认证

请求体:

{
------WebKitFormBoundarykrI31quOkUn9798D
Content-Disposition: form-data; name="file"; filename="Signit%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E5%86%85%E5%AE%B9%E8%A7%84%E5%88%92.pdf"
Content-Type: application/pdf
------WebKitFormBoundarykrI31quOkUn9798D--
}

3.请求方式

POST

4.请求参数说明

a.请求示例

curl -X POST \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Date: Wed, 02 Nov 2016 03:25:54 GMT" \
--header "User-Agent: SignIt RestAPI Client v1.0.0" \
--header "Host: api.signit.cn" \
--header "Authorization:HmacSHA512 a1S0H2-U0-v5I-0586-017-z6D-7B5-K0h-1o0-G0-9923G3Xm:53f7ae4a-937b-4ddc-8872-42dd094d56eb:NCMwvHfZS9ZzB2SgVbRzTuS/N5yDRM8Ak6tRvCavHD5T9nKjydc9ha+Rj48e0YIFC5V9IRtFL8Z1d0hvse7Ulg==" \
-d \
 "{
------WebKitFormBoundarykrI31quOkUn9798D
Content-Disposition: form-data; name="file"; filename="Signit%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E5%86%85%E5%AE%B9%E8%A7%84%E5%88%92.pdf"
Content-Type: application/pdf
------WebKitFormBoundarykrI31quOkUn9798D--
}" 
"http://10.10.10.69/ws-rest/v1/users/1210/envelopes/d0d47c48-6347-44e8-a6de-8ed2cebeef9b/documents/form"

b.请求字段说明

字段 是否必填 类型 位置 长度 说明
user-id Long URL-PATH 用户id
envelope-id String UR:-PATH 信封id

5.响应参数说明

a.响应示例

  • 响应成功:
    {
      "resultStatusCode": "100600000",
      "resultCode": 0,
      "resultDesc": "操作成功",
      "resultData": {
          "documents": [
              {
                  "name": "“信易签”安装部署手册.pdf",
                  "size": 1634.73,
                  "time": 1490235039000,
                  "location": "/res/user/bc8fc271a9d644718c6b7a2e0f267fa6/docs/pdf/converts/4e44465f-f7ea-45c0-a8a4-9fc395d61cf8.pdf",
                  "imageLocation": "/ws-rest/v1/documents/7b3e9d42-fe44-46dc-bfe0-ac0d665150d9/images/d8ae4cce-7e36-4c1d-9c15-48e2bc1352f0.png?page=-1",
                  "opsPageSignCount": 0,
                  "contentType": "application/pdf",
                  "docId": "7b3e9d42-fe44-46dc-bfe0-ac0d665150d9",
                  "href": "/ws-rest/v1/users/1210/envelopes/d0d47c48-6347-44e8-a6de-8ed2cebeef9b/documents/7b3e9d42-fe44-46dc-bfe0-ac0d665150d9?fields=to_pdf_location,serial_code,id,time,image_location,location,to_pdf_original_location,name,ops_page_sign_count,size,to_pdf_location,serial_code,id,time,image_location,location,to_pdf_original_location,name,ops_page_sign_count,size",
                  "containsPdfFormFields": false
              }
          ]
      }
    }
    
  • 响应失败:
    {
      "resultStatusCode": "100600102",
      "resultCode": 1,
      "resultDesc": "空信封异常"
    }
    

b.响应字段说明

字段 必填 类型 位置 长度 说明
resultStatusCode string BODY 固定值 结果状态码
resultCode int BODY 固定值-0,1 结果码,0-成功,1-失败,具体含义见结果状态码
resultDesc string BODY 操作结果说明,见其包含信息
documents OBJECT BODY 文档对象
docId String BODY 文档id
name String BODY 文档名字
size int BODY 文档大小
time int BODY 文档上传时间
opsPageSignCount integer BODY 可选签名域个数
href String BODY 当前文档资源链接
imageLocation String BODY 缩略图链接
location String BODY 文档下载链接

results matching ""

    No results matching ""