沙箱环境使用说明

更新时间:2024-07-10 17:24:46

沙箱环境用于企业开发者进行接口开发、调试,沙箱应用仅可以在沙箱环境中调用。为保障沙箱环境服务稳定性,请您不要随意进行压力测试及安全攻击。如需,请先联系e签宝工作人员进行报备申请,否则e签宝运维及安全团队有权禁用异常应用或IP的请求来保障服务稳定性。

注:

  • 沙箱环境中所产生的数据及操作仅用于接口联调测试,不可用于正式业务。
  •  如需转正式环境使用(正式环境上线),企业开发者需提前2-3天向e签宝工作人员报备上线计划,以便e签宝工作人员做上线引导及套餐配置。

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

1、使用登录e签宝开放平台(open.esign.cn)。沙箱环境开通前请确保已完成开发者企业的实名认证

特别说明:沙箱环境的应用ID是通过【正式开放平台(open.esign.cn)】里面的【沙箱服务】来开通创建的。

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

步骤2:沙箱环境开通

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

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

步骤3:沙箱应用创建

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

说明:

应用名称:请结合自身业务情况填写,建议填写平台或系统名称。当使用e签宝短信服务时,短信中将显示此应用名称。

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

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

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

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

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

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

【说明/提示】

指定公网出口 IP:仅指定的网络运营商(移动、联通和电信)或云服务(阿里云、腾讯云、百度云和华为云)所分配的互联网 IP 才可以与 e签宝服务端进行网络通讯,请添加具体IP地址。

任意公网出口IP:如果不清楚公网 IP 信息,紧急情况下可以不限制IP,先添加一个*到 IP 白名单中。为了保障 API 调用具有双重安全防护,不建议长期配置 * 。

注意:

  • IP白名单配置后,5分钟左右生效。
  • 沙箱模拟环境不可用于正式业务。
  • 若开发者服务所处网络需要配置防火墙后才能访问互联网资源,请按照《网络防火墙白名单配置说明》进行相关配置。

步骤6:配置重定向域名白名单

若不存在从e签宝相关页面重定向跳转到贵司相关系统页面的情况,此步骤可忽略。

若存在从e签宝相关页面重定向跳转到贵司相关系统页面时,不希望被e签宝外链跳转风控拦截而弹出风险提示页(详见下方示例图)。请点击【应用服务】-【应用管理】-【我的应用】后在右侧应用列表页面中,找到当前需要添加重定向域名白名单的应用ID所在行,点击行尾【配置】进入【安全配置】页进行添加。如下图:

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

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


我要纠错