开发前准备

沙箱环境操作说明

沙箱环境用于企业开发者进行接口开发、调试，沙箱应用仅可以在沙箱环境中调用。

沙箱环境中所产生的数据及操作仅用于接口联调测试，不可用于正式业务。

为保障沙箱环境服务稳定性，请您不要随意进行压力测试及安全攻击。如需，请先联系e签宝工作人员进行报备申请，否则e签宝运维及安全团队有权禁用异常应用或IP的请求来保障服务稳定性。

步骤1：登录并进入e签宝开发者控制台

1、使用e签宝企业账号登录e签宝开放平台。沙箱环境开通前请确保企业账号已完成企业实名认证。

2、登录成功后点击导航栏中的【控制台】进入企业开发者控制台。如下图：

步骤2：沙箱环境开通

如果您已开通沙箱环境（或非首次创建沙箱应用），可忽略此步骤。

进入e签宝开发者控制台后可先选择【沙箱服务】然后在页面下方选择【SaaS服务】或【PaaS服务】后，点击【立即开通】按钮来开通沙箱环境。如下图：

说明：

SaaS服务：基于SaaS产品提供标准化服务，接入电子签名服务SaaS API时可选择此项。

PaaS服务：基于PaaS产品提供灵活化服务，接入电子签名服务PaaS API、电子签名服务SDK、认证服务API和数据存证API时可选择此项。

步骤3：沙箱应用创建

点击【沙箱服务】-【沙箱应用】-【我的应用】后，再点击【新建应用】按钮进入“新建应用”页面，填写“应用名称”并选择对应“接入服务”即可。如下图：

说明：

SaaS服务：基于SaaS产品提供标准化服务，接入电子签名服务SaaS API时可选择此项。

PaaS服务：基于PaaS产品提供灵活化服务，接入电子签名服务PaaS API、电子签名服务SDK、认证服务API和数据存证API时可选择此项。

应用名称：请结合自身业务情况填写。当使用e签宝短信服务时，短信中将显示此应用名称。

短信内容如：验证码：123456，您正在某某某进行签署确认……

步骤4：查看已创建沙箱应用信息

点击【沙箱服务】-【沙箱应用】-【我的应用】后在右侧应用列表页面中查看到应用ID（App Id）和应用Secret（App Key），用于API接口调用。如下图：

步骤5：添加请求IP白名单

沙箱应用创建成功后，必须先将接口请求调用方公网出口IP添加到IP白名单中才可以成功访问、调用API接口。

点击【沙箱服务】-【沙箱应用】-【我的应用】后在右侧应用列表页面中，找到当前需要添加IP白名单的应用ID所在行，点击行尾【配置】进入IP白名单添加页面。如下图：

说明：

接口请求调用方公网出口 IP：网络运营商（移动、联调和电信）或云服务（阿里云、腾讯云、百度云和华为云）所分配的互联网 IP 地址，接口请求调用方通过此 IP 与 e签宝服务端进行通讯。

任意公网出口 IP：如果不清楚接口请求调用方公网 IP 信息或不需要限制接口请求调用方公网 IP 时可添加一个*到 IP 白名单中。如下图：

沙箱应用余额/次数不足时如何充值

沙箱服务开通时，e签宝自动为其配置一定金额/次数的免费调试套餐，以便接口调试。如接口调试时出现余额/次数不足时请将应用ID（App Id）和所调用的产品名称一同告知e签宝工作人员即可重新获取免费调试套餐。

转正式环境操作说明

正式环境为已上线应用提供服务，企业开发者要保证正式业务全部切换到e签宝正式环境。

为保障正式环境服务稳定性，请您不要随意在正式环境进行压测及安全攻击。e签宝运维及安全团队监控到来自贵司应用ID异常请求时将采取相关措施以保障服务稳定性。

建议：企业开发者提前2-3天向e签宝工作人员报备上线计划，以便e签宝工作人员做上线引导及套餐配置。

步骤1：登录并进入e签宝开发者控制台

1、使用e签宝企业账号登录e签宝开放平台。服务上线转正式前请确保企业账号已完成企业实名认证。

2、登录成功后点击导航栏中的【控制台】进入企业开发者控制台。如下图：

步骤2：正式应用创建

点击【应用服务】-【应用管理】-【我的应用】后，再点击【新建应用】按钮进入“新建应用”页面，填写“应用名称”后点击“提交”即可。如下图：

说明：

应用名称：请结合自身业务情况填写。当使用e签宝短信服务时，短信中将显示此应用名称。

短信内容如：验证码：123456，您正在某某某进行签署确认……

步骤3：查看已创建正式应用信息

点击【应用服务】-【应用管理】-【我的应用】后在右侧应用列表页面中找到已创建的应用ID所在行，点击行尾的【配置】即可查看正式应用信息。如下图：

步骤4：添加请求IP白名单

正式应用创建成功后，必须先将接口请求调用方公网出口IP添加到IP白名单中才可以成功访问、调用API接口。

点击【应用服务】-【应用管理】-【我的应用】后在右侧应用列表页面中，找到当前需要添加IP白名单的应用ID所在行，点击行尾【配置】进入IP白名单添加页面。如下图：

说明：

接口请求调用方公网出口 IP：网络运营商（移动、联调和电信）或云服务（阿里云、腾讯云、百度云和华为云）所分配的互联网 IP 地址，接口请求调用方通过此 IP 与 e签宝服务端进行通讯。

任意公网出口 IP：如果不清楚接口请求调用方公网 IP 信息或不需要限制接口请求调用方公网 IP 时可添加一个*到 IP 白名单中。如下图：

步骤5：替换正式应用信息及服务访问地址

企业开发者应该将API集成开发代码中的应用ID（AppId）和应用密钥（AppKey）替换成上述步骤3中所查询到的正式应用信息。

同时，按照下列信息将请求域名地址替换成正式环境地址。

注：如果贵司有网络安全要求，需要进行安全防火墙配置，那么可以按照上述信息配置防火墙。沙箱环境不可用于正式业务。

步骤6：正式应用套餐如何配置

正式上线前，需要提前2-3天与e签宝工作人员进行上线报备，告知计划上线时间。e签宝工作人员将协助企业开发者进行上线前准备工作指导以及套餐配置。

数据存证API涉及的域名列表

如果贵司有安全要求需要防火墙配置后才可以访问数据存证API的域名，请根据下方信息进行贵司防火墙设置。

开发前必读

沙箱环境下调试数据存证属于测试存证数据，无法作为正式环境使用，开发者沙箱环境测试结束后，需要转入正式环境验收，正式环境下存证的数据为有效数据。

为了更加安全，公司将对TLS协议版本进行升级，升级后将不在支持TLS 1.0，请确保客户端协议使用TLS 1.1/1.2

升级影响：

所有使用TLS 1.0协议的客户端访问或者API调用都会报错。

升级措施：升级客户端版本以支持TLS 1.1/1.2，禁用TLS1.0协议

（1）使用e签宝电子签名SaaS API（轩辕API）、电子签名PaaS API（悟空API）、电子签名 SDK（悟空SDK）认证服务和数据存证的客户，请查阅开发语言官方手册，以确保开发语言网络请求时可以支持TLS 1.1/1.2

（2）使用e签宝SaaS版、e签宝签署页面（轩辕API/悟空API）和e签宝实名认证页面版的客户，请按照以下浏览器版本信息进行升级，以确保浏览器可以支持TLS 1.1/1.2。

升级版本如下：

IE 升级版本到IE 11及以上

Chrome 升级版本到Chrome 29及以上

Firefox 升级版本到Firefox 26及以上

Android 升级版本到Android 4.4及以上

Safari 升级版本到Safari 7及以上