杭州天谷信息科技有限公司

附录一 天印签章系统API接口说明

接口说明

若未遇特别说明，以下所有接口请求都需要进行签名，具体签名方法，参见《天印签章系统对接指南》中的"访问控制"章节

若未遇特别说明，所有接口颗粒机调用请采用"UTF-8"编码方式

公共响应参数说明

所有的响应参数格式如下：

只有业务正常的时候，才会返回data数据。以下所有接口说明中的响应参数说明都是对data对象的描述。

文档相关API

创建内部用户

功颗粒机能说明

通过调用此接口传入用户的信息可以创建天印签章系统内部签署者用户

请求URL

http:

杭州天谷信息科技有限公司

附录一 天印签章系统API接口说明

接口说明

若未遇特别说明，以下所有接口请求都需要进行签名颗粒机，具体签名方法，参见《天印签章系统对接指南》中的"访问控制"章节

若未遇特别说明，所有接口调用请采用"UTF-8"编码方式

公共响应参数说明

所有的响应参数格式如下：

只有业务正常的时候，才会返回data数据颗粒机。以下所有接口说明中的响应参数说明都是对data对象的描述。

文档相关API

创建内部用户

功能说明

通过调用此接口传入用户的信息可以创建天印签章系统内部签署者用户

请求URL

http://ip:port/es颗粒机ignpro/rest/account/apiAdd

请求方式

POST

请求参数

响应参数

更新内部用户

功能说明

通过调用此接口传入用户的信息可以更新天印签章系统内部签署者用户

请求URL

http://ip:po颗粒机rt/esignpro/rest/account/apiUpdate

请求方式

POST

请求参数

响应参数

删除内部用户

功能说明

通过调用此接口传入用户id可以删除天印签章系统内部签署者用户

请求URL

http:颗粒机//ip:port/esignpro/rest/account/apiDelete

请求方式

POST

请求参数

响应参数

内部用户创建模板印章

功能说明

为内部用户创建指定类型的模板印章

请求URL

http://i颗粒机p:port/esignpro/rest/seal/template/apiAddPersonal

请求方式

POST

请求参数

响应参数

内部用户创建证书

功能说明

为内部用户创建签名证书

请求URL

http://颗粒机ip:port/esignpro/rest/certmanage/apiCreate

请求方式

POST

请求参数

响应参数

创建外部用户

功能说明

通过调用此接口传入用户的信息可以创建天印签章系统外部签署者用户

请颗粒机求URL

http://ip:port/esignpro/rest/outaccount/add

请求方式

POST

请求参数

响应参数

更新外部用户

功能说明

通过调用此接口传入用户的信息可以更新天印签章系统外部签颗粒机署者用户

请求URL

http://ip:port/esignpro/rest/outaccount/apiUpdate

请求方式

POST

请求参数

响应参数

删除外部用户

功能说明

通过调用此接口传入用户id可以删颗粒机除天印签章系统外部签署者用户

请求URL

http://ip:port/esignpro/rest/outaccount/apiDelete

请求方式

POST

请求参数

响应参数

外部用户创建模板印章

功能说明

为外颗粒机部用户创建指定类型的模板印章

请求URL

http://ip:port/esignpro/rest/outaccount/createSeal

请求方式

POST

请求参数

响应参数

外部用户创建证书

功能说明

为外部颗粒机用户创建签名证书

请求URL

http://ip:port/esignpro/rest/outaccount/createCert

请求方式

POST

请求参数

响应参数

无意愿认证摘要签署

功能说明

将签署场景信息发颗粒机送到天印签章系统，由天印签章系统做摘要并进行签署，返回签名结果和签署记录id

请求URL

请求方式

POST

请求参数

响应参数

意愿认证摘要签署

功能说明

将签署场景信息发送到天印签章系统，由天印签章系统做摘要并进颗粒机行签署，返回签名结果和签署记录id

请求URL

http://ip:port/esignpro/rest/sign/api/hashSign

请求方式

POST

请求参数

响应参数

获取文件上传路径

功能说明

PDF文颗粒机件上传采用直传方式。需要先向天印签章系统获取授权后的直传URL，将PDF文件通过PUT方式直传至天印签章系统。

请求URL

http://ip:port/esignpro/rest/filemanage/颗粒机getUploadUrl

请求方式

POST

请求参数

响应参数

内部用户api文档签署

功能说明

将文档上传到天印签章系统进行签名，先调用获取文件上传路径接口，将文档上传到天印签章系统，然后用返回的fileKey颗粒机调用当前接口进行文档签名

请求URL

http://ip:port/esignpro/rest/sign/apiSignWithoutAuth

请求方式

POST

请求参数

响应参数

保存信封信息

功能说明

文件上传成颗粒机功后，根据获取到的fileKey保存信封详细信息。保存成功后将产生信封唯一标识，用户后续签署使用。

请求URL

http://ip:port/esignpro/rest/envelope/create

请求颗粒机方式

POST

请求参数

响应参数

获取信封签署页面

功能说明

根据信封唯一标识获取信封的签署页面，只有待签署的信封可以获取，非待签署状态的信封将返回对应错误码。

请求URL

请求方式

POST

请求参数

响应参数

获取信封颗粒机信息

功能说明

根据信封唯一标识获取信封具体信息，得到信封各签署人的签署状态等信息。

请求URL

请求方式

POST

请求参数

响应参数

获取签署完成后文档

功能说明

获取签署完成的信封文档，只有签署完成的文档可以获取，颗粒机非签署完成状态的文档将返回对应错误码。

请求URL

http://ip:port/esignpro/rest/envelope/getFinishDocUrl

请求方式

POST

请求参数

响应参数

验证签名

功能说颗粒机明

根据签署记录和签署场景数据进行验签

请求URL

http://ip:port/esignpro/rest/sign/verifySign

请求方式

POST

请求参数

响应参数

无业务响应数据。根据公共响应数据确颗粒机认验证结果

通知说明

文档签署完成后，天印签章系统将通过同步通知和异步通知两种方式通知业务系统签署的结果。业务系统也可以定时调用天印签章系统接口获取签署结果。

同步通知方式：在签署页面中，患者完成签署后，天颗粒机印签章系统会将用户的浏览器重定向至"同步通知接收地址"。业务系统可以在同步通知接收地址中获取签署后的文档，做后续业务处理。

异步通知方式：在同步通知跳转的过程中如果用户异常关闭浏览器，可能导致同步通知接颗粒机收失败。因此，天印签章系统还提供了异步通知方式。天印签章系统将定时（每隔两分钟轮询一次）发送异步通知，异步通知接收地址返回的响应码为200时标识为通知成功，将不再发送通知。

调用API获取文档签署信息：颗粒机由于同步通知存在接收失败的概率；异步通知的定时触发的，存在一定延时。因此，还提供了独立API接口供业务系统调用，实时获取文档签署信息，获取签署后的PDF文件。

同步/异步通知内容（JSON格式）：

21

/颗粒机/ip:port/esignpro/rest/account/apiAdd

请求方式

POST

请求参数

响应参数

更新内部用户

功能说明

通过调用此接口传入用户的信息可以更新天印签章系统内部签署者用户

请求URL

h颗粒机ttp://ip:port/esignpro/rest/account/apiUpdate

请求方式

POST

请求参数

响应参数

删除内部用户

功能说明

通过调用此接口传入用户id可以删除天印签章系统内部签署者用颗粒机户

请求URL

http://ip:port/esignpro/rest/account/apiDelete

请求方式

POST

请求参数

响应参数

内部用户创建模板印章

功能说明

为内部用户创建指定类型的模板印章

请求颗粒机URL

http://ip:port/esignpro/rest/seal/template/apiAddPersonal

请求方式

POST

请求参数

响应参数

内部用户创建证书

功能说明

为内部用户创建签名证书

请颗粒机求URL

http://ip:port/esignpro/rest/certmanage/apiCreate

请求方式

POST

请求参数

响应参数

创建外部用户

功能说明

通过调用此接口传入用户的信息可以创建天印签颗粒机章系统外部签署者用户

请求URL

http://ip:port/esignpro/rest/outaccount/add

请求方式

POST

请求参数

响应参数

更新外部用户

功能说明

通过调用此接口传入用户的信息可以颗粒机更新天印签章系统外部签署者用户

请求URL

http://ip:port/esignpro/rest/outaccount/apiUpdate

请求方式

POST

请求参数

响应参数

删除外部用户

功能说明

通过调用此颗粒机接口传入用户id可以删除天印签章系统外部签署者用户

请求URL

http://ip:port/esignpro/rest/outaccount/apiDelete

请求方式

POST

请求参数

响应参数

外部用户创颗粒机建模板印章

功能说明

为外部用户创建指定类型的模板印章

请求URL

http://ip:port/esignpro/rest/outaccount/createSeal

请求方式

POST

请求参数

响应参数

外部用户颗粒机创建证书

功能说明

为外部用户创建签名证书

请求URL

http://ip:port/esignpro/rest/outaccount/createCert

请求方式

POST

请求参数

响应参数

无意愿认证摘要签署

功颗粒机能说明

将签署场景信息发送到天印签章系统，由天印签章系统做摘要并进行签署，返回签名结果和签署记录id

请求URL

请求方式

POST

请求参数

响应参数

意愿认证摘要签署

功能说明

将签署场景信息发送到天印签章系统，由颗粒机天印签章系统做摘要并进行签署，返回签名结果和签署记录id

请求URL

http://ip:port/esignpro/rest/sign/api/hashSign

请求方式

POST

请求参数

响应参数

获取文件上颗粒机传路径

功能说明

PDF文件上传采用直传方式。需要先向天印签章系统获取授权后的直传URL，将PDF文件通过PUT方式直传至天印签章系统。

请求URL

http://ip:port/esignpro/rest/颗粒机filemanage/getUploadUrl

请求方式

POST

请求参数

响应参数

内部用户api文档签署

功能说明

将文档上传到天印签章系统进行签名，先调用获取文件上传路径接口，将文档上传到天印签章系统，然后颗粒机用返回的fileKey调用当前接口进行文档签名

请求URL

http://ip:port/esignpro/rest/sign/apiSignWithoutAuth

请求方式

POST

请求参数

响应参数

保存信封颗粒机信息

功能说明

文件上传成功后，根据获取到的fileKey保存信封详细信息。保存成功后将产生信封唯一标识，用户后续签署使用。

请求URL

http://ip:port/esignpro/rest/envelo颗粒机pe/create

请求方式

POST

请求参数

响应参数

获取信封签署页面

功能说明

根据信封唯一标识获取信封的签署页面，只有待签署的信封可以获取，非待签署状态的信封将返回对应错误码。

请求URL

请求方式

POST

请颗粒机求参数

响应参数

获取信封信息

功能说明

根据信封唯一标识获取信封具体信息，得到信封各签署人的签署状态等信息。

请求URL

请求方式

POST

请求参数

响应参数

获取签署完成后文档

功能说明

获取签署完成的信封文档，只有签颗粒机署完成的文档可以获取，非签署完成状态的文档将返回对应错误码。

请求URL

http://ip:port/esignpro/rest/envelope/getFinishDocUrl

请求方式

POST

请求参数颗粒机

响应参数

验证签名

功能说明

根据签署记录和签署场景数据进行验签

请求URL

http://ip:port/esignpro/rest/sign/verifySign

请求方式

POST

请求参数

响应参数

无业务响应数颗粒机据。根据公共响应数据确认验证结果

通知说明

文档签署完成后，天印签章系统将通过同步通知和异步通知两种方式通知业务系统签署的结果。业务系统也可以定时调用天印签章系统接口获取签署结果。

同步通知方式：在签署页面颗粒机中，患者完成签署后，天印签章系统会将用户的浏览器重定向至"同步通知接收地址"。业务系统可以在同步通知接收地址中获取签署后的文档，做后续业务处理。

异步通知方式：在同步通知跳转的过程中如果用户异常关闭浏览颗粒机器，可能导致同步通知接收失败。因此，天印签章系统还提供了异步通知方式。天印签章系统将定时（每隔两分钟轮询一次）发送异步通知，异步通知接收地址返回的响应码为200时标识为通知成功，将不再发送通知。

调用A颗粒机PI获取文档签署信息：由于同步通知存在接收失败的概率；异步通知的定时触发的，存在一定延时。因此，还提供了独立API接口供业务系统调用，实时获取文档签署信息，获取签署后的PDF文件。

同步/异步通知内容（颗粒机JSON格式）：

21