跳转至

文件签署回调API

基本介绍

系统可以设置回调API,当文件上传、审批、签署完成时,系统会自动调用该API。通过该功能,实现该系统于其它系统的集成。

配置方式

每个方案可以单独配置回调API。在方案管理界面,配置回调API的URL地址。 配置回调

请求方式

POST方式,采用使用JSON格式将事件信息发送到回调API。

发送数据格式

    {
        "event": '事件名称',
        "data": {该事件相关的参数},
        "uservars": {用户定制的文件变量},
        "file": {
            "uploaded_time": '文件上传时间',
            "input": {上传的文件},
            "output": {签署后的文件},
            "file_id": '文件ID',
            "plan_id": '方案ID',
        }
    }

事件名称

  • file_uploaded: 文件上传
  • file_audit: 文件审批
  • signed: 文件签署结束