获取《创建流程模板》页面链接

接口描述

获取企业用户授权后，可以获取对应企业的模板创建页面（应用ID所属的平台自身企业无需做授权），该接口获取的流程模板制作链接参考图如下：

接口地址&请求方法

点击下述蓝色字体{host}可跳转至API请求域名说明文档

接口地址：https://{host}/v3/sign-templates/sign-template-create-url

请求方法：POST

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

展开全部参数参数名称				参数类型	必选	参数位置	参数说明
orgId				string	是	body	机构账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询
transactorPsnId				string	是	body	经办人账号ID 【注】通过【查询企业成员列表】查询企业成员的账号ID（psnId），经办人必须有模板操作权限，建议直接使用管理员账号
redirectUrl				string	是	body	创建完成后重定向地址（最长1024字符）【注】开发者需要在重定向地址上获取拼接的流程模板ID（signTemplateId）
hiddenOriginComponents				boolean	否	body	是否隐藏原始控件，默认false true-隐藏 false-不隐藏
customComponentGroups				list	否	body	要展示的自定义控件组ID列表自定义控件组请使用接口：【创建控件组】
customComponents				list	否	body	要展示的自定义控件ID列表自定义控件请使用接口：【创建自定义业务控件】
customBizNum				string	否	body	自定义业务编号用于标识自身业务与模板对应关系，在回调通知：《流程模板创建完成通知》里原样返回
uneditableFields				list	否	body	禁止用户在页面上修改或追加的内容 docs - 待签文件（隐藏添加、替换、删除签署文件按钮） participants - 参与方（隐藏签署方区域的签署方名称编辑按钮、添加企业和添加个人按钮以及删除按钮、顺序设置按钮）【注】禁止页面修改的前提是接口传入对应内容 docs - 待签文件对应以下fileIds字段 participants - 参与方对应以下participants字段
fileIds				list	否	body	待签署底稿文件ID列表（最多上传50份文件；目前仅支持pdf文件）【注】需提前调用《上传本地文件》接口将文件进行上传至e签宝；点击跳转如何上传文件
participants（点击“+”展开详情）				array	否	body	参与方信息
	participantFlag			string	是	body	参与方标识，同一个模板中不可重复会展示到模板页面上，所以建议设置为：甲方、乙方等容易理解的业务名词
	participantType			int	是	body	参与方类型 1 - 企业 2 - 个人
	participateBizType			string	是	body	参与方式 1 - 填写 2 - 签署既要填写也要签署，用英文逗号分隔："1,2"
	draftOrder			int	否	body	填写顺序，默认值1 可指定：1-255，不同参与人不可重复顺序小的先填写
	signOrder			int	否	body	签署顺序，默认值1 可指定：1-255，不同参与人可重复（重复就是可以同时签，不要求顺序）顺序小的先签署
	participantSetMode			int	是	body	参与要求（参与人指定方式） 1 - 使用模板时指定（由使用模板的人自行指定），通过流程模板创建合同拟定和签署流程接口发起流程时，需要在participants内传入具体参与方信息 2 - 固定成员（写死到模板中不可更改），在下方orgParticipant或psnParticipant参与方里指定具体的参与人信息 3 - 发起人本人（发起模板的是谁就指定谁），通过流程模板创建合同拟定和签署流程接口发起流程时，不需要传具体参与方信息，但需要在signFlowInitiator内指定发起人信息
	orgParticipant（点击“+”展开详情）			object	否	body	企业参与方 participantType=1时传入此对象仅在participantSetMode=2，即固定成员时生效
		orgName		string	是	body	企业名称
transactor（点击“+”展开详情）		object	是	body	企业参与方经办人
		transactorPsnAccount	string	是	body	经办人手机号/邮箱
	transactorName	string	是	body	经办人姓名
psnParticipant（点击“+”展开详情）			object	否	body	个人参与方 participantType=2时传入此对象仅在participantSetMode=2，即固定成员时生效
	psnAccount		string	是	body	个人手机号/邮箱
	psnName		string	谁	body	个人姓名
dedicatedCloudId				string	否	body	专属云项目ID 补充说明：（1）专属云：文件需要存储在开发者本地系统，购买了专属云服务时使用；（2）专属云项目ID获取方式：请先联系对接群内技术获取；

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	signTemplateCreateUrl	string	是	流程模板创建页面（该地址无需登录，有效期30分钟）

请求示例

{
        "orgId": "6b498644****11b590803b800",
        "transactorPsnId": "498644******b590803b120",
        "redirectUrl": "https://****.cn"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signTemplateCreateUrl": "https://smlh5.esign.cn/auth/guide?loginId=2a8***-3f**-4b60-a***-ded31***d61"
    }
}

流程模板签署服务API

获取《创建流程模板》页面链接

接口描述

接口地址&请求方法

请求头格式

请求参数

响应参数

请求示例

响应示例