7.2 Webhook回调接口：文件签名回调示例

POST

https://yourdomain.com/webhook/datasignature-callback

接⼝地址：由调⽤⽅提供，比如 https://yourdomain.com/webhook/pdfsignature-callback
接⼝类型：POST
参数位置：Body
接⼝描述：接收签名系统回传的⽂件签名结果
说明：回调接⼝不⽀持传递鉴权参数和额外的Header参数

请求参数

Authorization

Query 参数

access_token

string

必需

授权码；正式环境联系签署平台方获取

默认值:

3e9dec5f-4a9d-4af8-8abc-23e4675a1eb6

Header 参数

Content-Type

string

可选

示例值:

application/json

X-Signit-App-Id

string

必需

应用id；正式环境联系签署平台方获取

默认值:

1931fabdb516e66ca2f8c42691a

Body 参数application/json

event

string

事件名称

必需

envelopeCompleted = 文件签署完成
participantConfirmed = 参与者签名

eventDescription

string

事件名称描述

必需

target

object

推送目标

必需

destination

string

推送目标地址

必需

rawData

object

事件内容

必需

注：此字段在实际推送中是JSON格式的字符串，文档这里为了结构化展示说明使用了对象模式

business

object

业务信息

必需

envelope

object

信封文件信息

必需

appInfo

object

应用

必需

customTag

string

自定义业务编号

必需

invokeNo

string

调用唯一标识

必需

示例

{
  "event": "envelopeCompleted",
  "eventDescription": "信封流程完成",
  "target": {
    "destination": "http://172.21.1.15:8086/CASignInfo"
  },
  "rawData": "{\"business\":{\"patientId\":\"352401111076\",\"patientName\":\"赵彬\",\"admissionNumber\":\"A02502194\",\"idCard\":\"510823199807048945\",\"serviceType\":null,\"departmentName\":\"超声医学科\",\"departmentId\":\"1\",\"doctorName\":\"张玉麒\",\"doctorId\":\"3290\",\"serviceId\":\"61127617990786155\"},\"envelope\":{\"title\":\"chaoshengjianchabaogao\",\"envelopeWsid\":\"WSID_ENVE_0000018cf72a81abd28bfda326d70001\",\"status\":\"ED_SUCCESS\",\"statusDescription\":\"成功处理完成\",\"sendDatetime\":\"24-1-11 下午2:16\",\"finishedDatetime\":\"24-1-11 下午2:17\",\"files\":[{\"md5\":\"84b468fa5e83f46af3bf96e4d14d64a9\",\"name\":\"202401111416461613001737334001.pdf\",\"url\":\"https://hospital-api.signit.cn/v1/file/files/WSID_FILE_0000018cf72af5c85e4da8789e4922a5?token=05fb2749a93048c70d9f3e539863b8a4&salt=udQ56m8NckK1sw5041&open=true&ts=1704953855895&ets=3D08A5D9E6B7D551AE23C6EE0F8B8C27DFF69D416A8E7655\",\"wsid\":\"WSID_FILE_0000018cf72af5c85e4da8789e4922a5\",\"byteSize\":\"729925\"}]},\"appInfo\":{\"appId\":\"1854e7ba96f02420a0a0a171710\",\"appName\":\"自定义应用\"},\"customTag\":\"61127617990786155\",\"invokeNo\":\"202401111416461613001737334001_WSID_ENVE_0000018cf72a81abd28bfda326d70001\",\"returnUrl\":null,\"actions\":null}",
  "needCallBack": false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://yourdomain.com/webhook/datasignature-callback?access_token=' \
--header 'X-Signit-App-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"event": "envelopeCompleted",
	"eventDescription": "信封流程完成",
	"target": {
		"destination": "http://172.21.1.15:8086/CASignInfo"
	},
	"rawData": "{\"business\":{\"patientId\":\"352401111076\",\"patientName\":\"赵彬\",\"admissionNumber\":\"A02502194\",\"idCard\":\"510823199807048945\",\"serviceType\":null,\"departmentName\":\"超声医学科\",\"departmentId\":\"1\",\"doctorName\":\"张玉麒\",\"doctorId\":\"3290\",\"serviceId\":\"61127617990786155\"},\"envelope\":{\"title\":\"chaoshengjianchabaogao\",\"envelopeWsid\":\"WSID_ENVE_0000018cf72a81abd28bfda326d70001\",\"status\":\"ED_SUCCESS\",\"statusDescription\":\"成功处理完成\",\"sendDatetime\":\"24-1-11 下午2:16\",\"finishedDatetime\":\"24-1-11 下午2:17\",\"files\":[{\"md5\":\"84b468fa5e83f46af3bf96e4d14d64a9\",\"name\":\"202401111416461613001737334001.pdf\",\"url\":\"https://hospital-api.signit.cn/v1/file/files/WSID_FILE_0000018cf72af5c85e4da8789e4922a5?token=05fb2749a93048c70d9f3e539863b8a4&salt=udQ56m8NckK1sw5041&open=true&ts=1704953855895&ets=3D08A5D9E6B7D551AE23C6EE0F8B8C27DFF69D416A8E7655\",\"wsid\":\"WSID_FILE_0000018cf72af5c85e4da8789e4922a5\",\"byteSize\":\"729925\"}]},\"appInfo\":{\"appId\":\"1854e7ba96f02420a0a0a171710\",\"appName\":\"自定义应用\"},\"customTag\":\"61127617990786155\",\"invokeNo\":\"202401111416461613001737334001_WSID_ENVE_0000018cf72a81abd28bfda326d70001\",\"returnUrl\":null,\"actions\":null}",
	"needCallBack": false
}'

返回响应

🟢200成功

application/json

Body

code

string

状态码

必需

description

string

说明

必需

描述

示例

{
  "code": "0",
  "description": "接收成功"
}

🟠400参数不正确

修改于 2025-03-04 02:26:49

7.1 Webhook回调接口：数据签名示例

7.3 Webhook回调接口：数据签名v2回调示例