本章将介绍集成e签宝公有云服务过程中对于接入的流程、规范和注意事项,通过阅读本章内容可以提升e签宝公有云服务集成开发质量和效率。
1.项目工期及人员分工
项目阶段 | 任务内容 | 主责任人 | 配合人 | 参考工期 (自然日) |
客户建联 | (1)建立技术对接交流群 | e签宝交付顾问 | 贵司团队 | 1.0 |
业务梳理 | (1)组织人员进行实际业务集成接口梳理讨论 | 贵司团队 | e签宝交付顾问 | 2.0 |
集成开发 | (1)编写代码集成e签宝相关接口 | 贵司团队 | e签宝交付顾问 (技术答疑) | 10.0 |
(2)上线前在沙箱模拟环境接口联调测试 | 贵司团队 | e签宝交付顾问 (技术答疑) | 5.0 | |
业务上线 | (1)业务系统上线切换至e签宝正式生产环境 | 贵司团队 | e签宝交付顾问 (技术答疑) | 1.0 |
(2)业务系统使用培训 | 贵司团队 | - | 1.0 | |
参考工期总计(自然日): | 20.0 |
【说明】
e签宝公有云OpenAPI集成项目的交付与传统项目有着本质的区别,项目集成对接过程中需要贵司来牵头、制定和汇报项目进展。
因为,贵司的团队需要设计和编写代码将e签宝公有云OpenAPI相关接口集成到贵司业务系统中来使用,因此整体工作需要由贵司团队来负责制定实施计划、组织业务梳理、组织开发和测试以及后续上线后的相关事宜。
上述各阶段所需工期与贵司实际业务复杂度和开发团队人数有直接关系,通常情况下20天左右可集成对接完成。业务越复杂,对接周期越长。
在集成对接过程中,若遇到问题,贵司可查阅相关在线文档或寻求技术支持,e签宝交付顾问负责解答相关问题,辅导贵司快速完成e签宝OpenAPI集成。
2.应用接入流程
企业开发者接入开放平台,简而言之需要进行经历以上8个步骤:
1)文档阅读&业务梳理
企业开发者的项目经理、产品经理或研发人员应该先仔细阅读e签宝公有云产品文档了解产品形态及功能,并结合实际业务情况进行需求分析和业务梳理,以便让开发调试更高效。
2)企业开发者注册认证
只有成为企业开发者才有权限接入e签宝开放平台进行接口调用。操作步骤详见:企业实名认证注册流程。
3)创建沙箱应用
沙箱应用处于沙箱模拟环境中,主要用于企业开发者在接口开发测试阶段使用,不可用于正式业务。
沙箱应用创建步骤详见:e签宝沙箱模拟环境使用说明。
4)开发测试
企业开发者在接口开发测试时,请严格按照e签宝公有云API调用说明和具体接口文档中的描述和约束进行。
在接口调用时出现报错时,可通过开放平台-错误码查询进行自助查找解决方法,可通过API在线调试工具快速体验接口使用方法。
接口集成开发时在日志中请注意记录接口报错返回的错误码和错误描述信息,以方便问题的分析和解决。
5)创建正式应用
正式应用处于生产环境中,主要用于企业开发者正式业务使用。
正式应用创建步骤详见:e签宝正式生产环境使用说明。
6)订单套餐配置
生产环境内调用接口时需要确保已配置订单套餐,否则会出现“计费失败”类报错。
订单套餐配置步骤详见:客户上线配置套餐流程,配置过程中遇到问题可联系e签宝客户成功经理协助操作。
7)应用正式上线
企业开发者可参照正式生产环境使用说明切换到生产环境。如果接入方存在网络安全策略,请提前与接入方运维或安全团队申请互联网访问权限或配置网络代理。正式使用时,企业开发者请确保已成功切换到生产环境中。
8)线上运维
应用正式上线投入生产后,企业开发者需要注意线上接口报错情况,遇到大量报错时请及时排查接入方接口调用是否正确。
3.应用接入规范
1)如需接口压测或安全测试,请提前向e签宝交付顾问报备,未报备时e签宝安全团队有权封禁IP、上报网警。
2)为确保应用正式上线过程中问题可以及时得到技术支持,企业开发者应提前2-3天通知e签宝交付顾问上线计划,以便双方做好上线前相关准备工作。
3)在调用接口校验用户信息是否真实有效时,企业开发者应该先向用户展示《实名认证用户须知及隐私保护》让用户知晓信息将会上传至国家认可资质的数据服务提供商,以供验证身份真实性。用户表达同意后企业开发者才可以调用接口进行身份信息认证。
可点击下载《认证服务协议》进行参考。
4)在调用接口为用户创建签署账号申请数字证书时,企业开发者应该先向用户展示《数字证书服务协议》让用户知晓e签宝将代为向CA机构申请数字证书。用户表达同意后企业开发者才可以调用接口创建用户签署账号。
可点击下载《数字证书服务协议》进行参考。
5)在调用接口进行用户签章时,企业开发者应该先向用户展示相关电子签章授权调用协议,用户表达同意后企业开发者才可以调用接口进行用户电子签章。
可参考《自动盖章签署授权委托书》样例。
6)企业开发者应该先向用户展示待签署文件,在用户预览无误并表达同意签署后才可加盖电子签章。
4.接入注意事项
1)用户身份信息认证核验时,因各地数据上报机制或其他特殊情况,认证服务无法保证用户身份信息100%核验通过。因此,企业开发者应根据实际业务情况考虑针对特殊情况增加线下人工认证核验用户身份信息的方式,以防止业务阻塞。
2)电子签章需要基PDF格式文件来保障签名的有效性和文件防篡改,如果接入方业务中涉及各种不同格式的文件,可约定让用户上传待签署文件前另存为PDF格式来规避PDF格式转换失败情况,保障电子签章可顺利进行。
3)企业开发者应注意关注e签宝开放平台内“平台公告”版块,用于了解公有云产品最新动态。