签署
<p><strong>简要描述:</strong> </p>
<ul>
<li>签署接口</li>
</ul>
<p><strong>请求URL:</strong> </p>
<ul>
<li><code>http://ip:port/service/rest/v1/signflow/sign</code></li>
</ul>
<p><strong>请求方式:</strong></p>
<ul>
<li>POST</li>
</ul>
<p><strong>参数:</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">participantId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>签署流程参与人Id</td>
</tr>
<tr>
<td style="text-align: left;">accountUid</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>当前用户的accountUid, 标准签中可以不传,默认为当前登录账号的accountUid</td>
</tr>
<tr>
<td style="text-align: left;">isAutoComplete</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>是否自动完结,默认1</td>
</tr>
<tr>
<td style="text-align: left;">validateType</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>意愿认证类型, 0-验证码校验 1-签署密码</td>
</tr>
<tr>
<td style="text-align: left;">docSignInfoList</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">List</td>
<td>包含文档Id: flowDocId 以及签署位置及印章信息</td>
</tr>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>验证码</td>
</tr>
<tr>
<td style="text-align: left;">source</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>请求来源,例如:’dingding’ , ’esign’ , ’esign_h5’ , ’alipay’</td>
</tr>
</tbody>
</table>
<p>签署位置及印章信息</p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">sealId</td>
<td style="text-align: left;">String</td>
<td>印章Id</td>
</tr>
<tr>
<td style="text-align: left;">posX</td>
<td style="text-align: left;">float</td>
<td>签署位置X坐标</td>
</tr>
<tr>
<td style="text-align: left;">posY</td>
<td style="text-align: left;">float</td>
<td>签署位置Y坐标</td>
</tr>
<tr>
<td style="text-align: left;">posPage</td>
<td style="text-align: left;">String</td>
<td>签署页码, 骑缝签时页码格式为<em>-</em></td>
</tr>
<tr>
<td style="text-align: left;">key</td>
<td style="text-align: left;">String</td>
<td>关键字</td>
</tr>
<tr>
<td style="text-align: left;">signType</td>
<td style="text-align: left;">int</td>
<td>签章类型,0-关键字签署 1-单页签 3-骑缝签</td>
</tr>
</tbody>
</table>
<ul>
<li>备注:无</li>
</ul>
<p><strong>请求示例</strong></p>
<pre><code> http://ip:port/service/rest/v1/signflow/sign
{
&quot;participantId&quot;:&quot;8b43e4c7-1f30-4bc3-a960-f46c1d879d73&quot;,
&quot;source&quot;:&quot;esign&quot;, //操作来源
&quot;isAutoComplete&quot;:0, //是否自动校验流程完结并存证
&quot;validateType&quot;: 0, //意愿认证类型, 0-验证码校验 1-签署密码
&quot;code&quot;:&quot;7712&quot;, //验证码或签署密码
&quot;docSignInfoList&quot;:[{
&quot;flowDocId&quot;:&quot;db906aa3-00bb-4adb-be52-09fd46c8a4af&quot;,
&quot;posArray&quot;:[{
&quot;sealId&quot;:&quot;33867baa-ce64-4a6e-80ca-eb419adf26dc&quot;,
&quot;posX&quot;:50, //签署位置横坐标
&quot;posY&quot;:50, //签署位置纵坐标
&quot;posPage&quot;:1, //文档的签署页码
&quot;signType&quot;: 0, //签章类型
}]},{
&quot;flowDocId&quot;:&quot;75107b49-0b9c-4309-968e-79118550f925&quot;,
&quot;posArray&quot;:[{
&quot;sealId&quot;:&quot;2dbb2c7d-9f1a-45a4-9cbd-8d1a5fffb46c&quot;,
&quot;posX&quot;:100, //签署位置横坐标
&quot;posY&quot;:100, //签署位置纵坐标
&quot;posPage&quot;:1, //文档的签署页码
&quot;signType&quot;: 0, //签章类型
}]
}]
}</code></pre>
<p><strong>返回示例</strong></p>
<pre><code>{
&quot;success&quot;: true,
&quot;msg&quot;: &quot;成功&quot;,
&quot;total&quot;: null,
&quot;errCode&quot;: 0,
&quot;errShow&quot;: false,
&quot;data&quot;: {
&quot;docList&quot;: [
{
&quot;flowDocId&quot;: &quot;b2bd5188-2b11-40c5-8fff-a8fd4bfd05fb&quot;,
&quot;userFileId&quot;: &quot;f5c412ab-55a5-43a4-be38-c88f3f58831c&quot;,
&quot;flowDocName&quot;: &quot;概要设计说明书模板.docx&quot;,
&quot;posList&quot;: null,
&quot;ossKey&quot;: &quot;web/761ff5b1-4fdc-4036-8cda-4deae51d33ae.pdf&quot;,
&quot;url&quot;: &quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/web/761ff5b1-4fdc-4036-8cda-4deae51d33ae.pdf?Expires=1505944747&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=unLiXfk6G4RfMjcf1vrGm%2B5JDrA%3D&quot;,
&quot;reviewUrl&quot;: &quot;https://esignoss.oss-cn-hangzhou.aliyuncs.com/pdf2Image/RPbPoGA_mg83PCdiC52jnnQxN9K3mbSiw0fIlio2nik%3D_5_1_50?Expires=1505912667&amp;OSSAccessKeyId=FBzUaPMorqiiUAfb&amp;Signature=frekki3IYqml0ILN8ij7tpzkqUs%3D&quot;,
&quot;page&quot;: 5
}
]
}
}</code></pre>
<p><strong>返回参数</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">flowDocId</td>
<td style="text-align: left;">String</td>
<td>签署流程文档ID</td>
</tr>
<tr>
<td style="text-align: left;">userFileId</td>
<td style="text-align: left;">String</td>
<td>用户文件Id</td>
</tr>
<tr>
<td style="text-align: left;">flowDocName</td>
<td style="text-align: left;">String</td>
<td>文件名称</td>
</tr>
<tr>
<td style="text-align: left;">posList</td>
<td style="text-align: left;">List</td>
<td>指定位置信息</td>
</tr>
<tr>
<td style="text-align: left;">ossKey</td>
<td style="text-align: left;">String</td>
<td>文件的ossKey</td>
</tr>
<tr>
<td style="text-align: left;">url</td>
<td style="text-align: left;">String</td>
<td>文件的下载地址</td>
</tr>
<tr>
<td style="text-align: left;">reviewUrl</td>
<td style="text-align: left;">String</td>
<td>文件首页预览地址</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">int</td>
<td>文件页数</td>
</tr>
</tbody>
</table>
<p><strong>备注</strong> </p>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>