重庆市工程项目数字化管理平台操作手册.docx

重庆市工程项目数字化管理平台操作手册.docx

《重庆市工程项目数字化管理平台操作手册.docx》由会员分享，可在线阅读，更多相关《重庆市工程项目数字化管理平台操作手册.docx（12页珍藏版）》请在冰点文库上搜索。

重庆市工程项目数字化管理平台操作手册

附件1

重庆市工程项目数字化管理平台

操作手册

2020年3月

1．阅读指南

本文档可以帮助您快速了解和掌握重庆市工程项目数字化管理平台（以下简称“平台”）的业务流程和具体调用方法，主要介绍接入流程、各个接口的详细参数说明、返回值的说明等信息。

平台URL地址是http:

//221.7.85.94:

6020。

本文档适用于平台与项目数字化无纸化管理系统（以下简称“数字化管理系统”）之间的开发集成操作。

2．系统的功能

平台主要作用于工程项目的数字化管理工作，其主要功能包含：

平台核心服务、API接口服务。

平台核心服务提供标准文档服务、认证授权服务、人脸识别服务、签字签章服务、原笔迹签字服务。

数字化管理系统需要接入API接口服务。

3．接入流程

图3-1平台接入流程

4．接入服务说明

本章节主要介绍接入服务接口流程、以及各流程所含的具体接口信息，以及调用接口服务“操作成功”的返回值示例参考。

4.1第一步：

接入鉴权

平台会对各个数字化管理系统进行身份的验证，以确保安全的接入服务。

所以在调用正式服务接口前，需要先调用此接口进行鉴权，对应的接口地址如下所示。

•接口地址：

/esign/paperless/query/getToken

4.2第二步：

项目准入流程

工程项目数字化平台提供项目准入流程，通过项目准入码对项目的参建单位信息进行采集准入，所需要用到的接口见4.2.1至4.2.3，整体流程如下图所示：

图4.2-1项目准入流程

4.2.1单位信息提交接口

平台提供对参建单位信息的采集功能，通过此接口可以将参建单位的信息提交到平台。

•接口地址：

/esign/paperless/api/subCompany

4.2.2单位信息修改接口

平台提供对参建单位信息修改的功能，通过此接口可以更新单位基本资料信息，其中，“统一社会信息代码”不可更新。

•接口地址：

/esign/paperless/api/updateCompanyInfo

4.2.3查询单位信息接口

通过此接口可以查询单位的基本信息。

•接口地址：

/esign/paperless/api/getCompanyInfo

4.3第三步：

提交印章、人员签名审核流程

平台提供人员信息、印章、人员签名的采集审核功能，主要是需要对项目参建单位及其业务人员做资料备案，以确保印章、签名、人员身份的真实性，所需要用到的接口见4.3.1至4.3.10，整体审核流程如下图所示：

图4.3-1参建单位提交印章、人员签名审核流程

4.3.1添加员工接口

平台提供对业务人员信息的采集功能，通过此接口可以将参建单位人员信息提交到平台，进行人员信息添加。

•接口地址：

/esign/paperless/api/addPerson

4.3.2修改员工信息接口

平台提供对业务人员信息的修改功能，通过此接口可以修改员工基本信息。

•接口地址：

/esign/paperless/api/updatePersonInfo

4.3.3删除员工接口

通过调用该接口可以删除指定员工的信息。

•接口地址：

/esign/paperless/api/deletePerson

4.3.4人脸采集接口

平台需要对项目参建方业务人员的脸部特征进行采集，以确保人员身份的真实性。

数字化管理系统通过调用此接口，可以注册对应业务人员的人脸基础数据。

•接口地址：

/faces/add

4.3.5查询员工信息接口

通过调用此接口可以查询员工基本信息接口及人脸信息采集状态。

•接口地址：

/esign/paperless/api/getPersonInfo

4.3.6添加、修改员工签名接口

平台需要对项目参建方业务人员的签名信息进行采集，以确保人员身份的真实性。

数字化管理系统通过调用此接口，可以设置员工的签名。

•接口地址：

/esign/paperless/api/persons/signature

4.3.7添加印章权限接口

平台提供参建单位对本单位内印章权限的控制功能，通过该接口可指定参建单位内的人员使用印章的权限。

•接口地址：

/esign/paperless/api/addSealRight

4.3.8添加印章接口

平台需要对项目参建单位的印章信息进行采集，以确保印章的真实性。

数字化管理系统通过调用此接口，可以将参建单位印章提交到平台备案，该接口同时支持单个印章添加与多个印章添加。

•接口地址：

/esign/paperless/api/addSeals

4.3.9删除印章接口

通过调用此接口，可以删除参建单位的企业印章信息。

•接口地址：

/esign/paperless/api/deleteSeal

4.3.10查询企业印章接口

平台提供参建单位查询企业印章信息的功能，可以通过调用此接口查询本单位的印章信息。

•接口地址：

/esign/paperless/api/getSeals

4.4第四步：

行为数据及标准文档流程

各数字化管理系统完成基本信息采集备案之后，可以进行实际业务的操作，可以通过这一步实现标准文档的查询、标准文档规范的查询、填报上传结构化数据以及对项目过程文档的附件内容的上传等操作，所需要用到的接口见4.4.1至4.4.6，整体流程如下图所示：

图4.4-1行为数据及标准文档流程

4.4.1查询标准文档接口

该接口用于查询平台标准文档信息，可通过该接口获取标准文档编号。

•接口地址：

/esign/paperless/api/getTemplates

4.4.2查询标准文档参数接口

该接口用于参建单位根据标准文档编号查询对应的输入域参数信息。

•接口地址：

/esign/paperless/api/getTemplateVariables

4.4.3查询文档规范接口

数字化管理系统实现在线填报制作页面的结构化数据组装，以可视化直观的文档展示给数字化管理系统，明确平台需要的结构化数据字段，image_xxx为base64图片字段。

•接口地址：

/esign/paperless/api/reviewTemplateForm

4.4.4上传结构化数据生成文档接口

该接口用于数字化管理系统上传用户填报的结构化数据，平台会根据收到的数据生成相应的过程文档，调用成功会返回过程文档唯一标识，在后面的签字签章等接口中会使用到该标识。

•接口地址：

/esign/paperless/api/addDoc

4.4.5上传“过程文档”附件资料（文件、音频、视频等）接口

用于数字化管理系统上传过程文档的附件资料，可能包含图片、文件、音视频等附件资料至平台，平台做备案存储管理。

•接口地址：

/esign/paperless/api/uploadDocAnnex

4.4.6查询“过程文档”附件接口

该接口用于数字化管理系统查询“过程文档”的附件资料，平台将压缩返回此“过程文档”的所有附件信息。

•接口地址：

/esign/paperless/api/getDocAnnex

4.5第五步：

文档签字签章流程

各数字化管理系统在完成过程文档上传后，需要对过程文档发起签字、签章，主要分为以下几个小步骤来完成：

1）根据文档唯一标识获取文档的签字、签章位置；

2）根据文档唯一标识、印章（在第三步中的查询企业印章接口中取得）或签名等信息创建一个签字签章任务；

3）对签字人或使用印章的人员进行人脸识别，验证是否为本人；

4）人脸识别认证通过后，根据认证成功后返回的唯一成功标识与创建签字签章任务返回的任务标识完成本次的签字或签章任务；

文档签字签章所需要用到的接口见4.5.1至4.5.6，整体流程如下图所示：

图4.5-1文档签字签章流程

4.5.1获取文档签字签章位置接口

该接口用于参建单位根据过程文档唯一标识查询对应文档的签字签章位置信息。

•接口地址：

/esign/paperless/api/getSignLocation

4.5.2创建签字签章任务接口

过程文档签字签单前，需要调用该接口创建签字签章任务。

•接口地址：

/esign/paperless/api/createTodoTask

4.5.3人脸比对接口

用于数字化管理系统上传需要身份验证的待检测照片至平台，平台将返回比对结果。

•接口地址：

/faces/recognitionToFace

4.5.4获取人员签名接口

该接口用于获取人员签名。

•接口地址：

/esign/paperless/api/getPersonSignature

4.5.5签字签章接口

该接口用于对过程文档完成签字签章。

•接口地址：

/esign/paperless/api/sign

4.5.6下载文档接口

该接口用于数字化管理系统下载预览过程文档。

•接口地址：

/esign/paperless/api/doc/review

4.6第六步：

文档废除流程

平台提供了文档数据防篡改验证功能和文件废除接口，各数据化管理系统可以调用这两个接口对文档进行验证或根据实际需求废除相关文档，在下图举例简单说明了文档的废除流程:

图4.6-1文档废除流程

4.6.1文档数据防篡改验证接口

用于数字化管理系统验证文档是否被篡改。

数字化管理系统调用该服务上传过程文档结构化数据至平台，平台接收上传的结构化数据进行比对验证，并返回验证结果。

•接口地址：

/esign/paperless/api/checkData

4.6.2废除文档接口

该接口用于过程文档填报方对已存在的过程文档进行作废处理。

•接口地址：

/esign/paperless/api/doc/abolish

4.7第七步：

工程文档归档流程

平台提供了项目归档功能，各数字化管理系统在完成所有过程资料提交完成后，可以调归档接口实现资料归档，在本步骤提供了两个接口，分别是上传项目过程资料（文件、音频、视频等）接口与文件归档接口，归档的整体流程如下所示：

图4.7-1工程资料归档流程

4.7.1上传项目过程资料（文件、音频、视频等）接口

用于数字化管理系统上传项目过程中产生的文件、音视频等附件资料至平台，平台做备案存储管理。

•接口地址：

/esign/paperless/api/uploadProjectFile

4.7.2文档归档接口

项目参建单位调用此接口，对项目下所有工程资料进行归档，提交到城建档案馆留存。

•接口地址：

/esign/paperless/api/docFiled