添加填写控件

更新时间:2021/07/06 01:08:51

文档变更说明

原接口的中文名称由“添加输入项组件”变更为“添加填写控件”,其接口功能未做调整。

接口描述

通过 templateId 模板ID向PDF模板文件中添加填写控件,以便后续通过这些填写控件来填充内容。

接口地址

/v1/docTemplates/{templateId}/components

请求方法

POST

请求头

提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。

方式一:请求签名鉴权

请求头入参示例如下:

参数名称

类型

必选

参数说明

示例值

X-Tsign-Open-App-Id

string

项目ID


Content-Type

string

application/json;charset=UTF-8


X-Tsign-Open-Ca-Timestamp

string

API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击


Accept

string

建议统一填写 */*


X-Tsign-Open-Ca-Signature

string

签名字符串


Content-MD5

string

当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。


X-Tsign-Open-Auth-Mode

string

选择请求方式进行鉴权,固定值,Signature


方式二:OAuth2.0鉴权

当安全接入选择OAuth2.0鉴权方式请点击查阅详情,请求头入参示例如下:

参数名称

类型

必选

参数说明

X-Tsign-Open-App-Id

string

项目ID

X-Tsign-Open-Token

string

通过获取鉴权Token接口返回

Content-Type

string

application/json; charset=UTF-8


请求参数

参数名称

类型

必选

参数类型

参数说明

示例值

templateId

string

path

模板id,该参数需放在请求地址里面,可以参考【请求示例】


structComponent

array

body




id

string

body

输入项组件id,使用时可用id填充,为空时表示添加,不为空时表示修改


key

string

body

模板下输入项组件唯一标识,使用模板时也可用根据key值填充


type

int

body

输入项组件类型,1-单行文本,2-数字3-日期,6-签约区8-多行文本11-图片不支持修改


context

object

body

输入项组件上下文信息,包含了名称,填充格式,样式以及坐标



label

string

body

输入项组件显示名称


required

boolean

body

是否必填,默认true


limit

string

body

输入项组件type=2,type=3时填充格式校验规则;数字格式如:# 或者 #00.0# 日期格式如: yyyy-MM-dd


style

object

body

输入项组件样式



width

float

body

输入项组件宽度


height

float

body

输入项组件高度


font

int

body

填充字体,默认1,1-宋体,2-新宋体,4-黑体,5-楷体


fontSize

float

body

填充字体大小,默认12


textColor

string

body

字体颜色,默认#000000黑色


pos

object

body

输入项组件坐标



page

int

body

页码


x

float

body

x轴坐标,左下角为原点


y

float

body

y轴坐标,左下角为原点


公共响应参数

参数名称

类型

必选

参数说明

示例值

code

int

业务码,0表示成功


message

string

信息


data

array

添加/编辑的输入项组件id列表


请求示例  

POST https://openapi.esign.cn/v1/docTemplates/【模板id】/components


{
    "structComponent":[
        {
            "id":"45dd9420690b460c9e5ed55b40d7d0f8",
            "key":"key001",
            "type":1,
            "context":{
                "label":"身份证号码",
                "limit":"yyyy-MM-dd",
                "required":true,
                "style":{
                    "font":1,
                    "fontSize":11,
                    "textColor":"#000000",
                    "width":11.11,
                    "height":11.11
                },
                "pos":{
                    "x":11.11,
                    "y":11.11,
                    "page":1
                }
            }
        }
    ]
}

响应示例

{
	"code": 0,
	"data": ["dfadfasdadasdfasdfsadfsadf"],
	"message": "成功"
}

错误码

错误码

错误描述

解决方案

1430011

输入项组件不存在

structComponent/id参数需要为空