# 一、应用管理
应用(App)是调用氦闪中台所有接口的身份标识。所有接口调用都需要以应用作为标识,因此必须先创建应用,才能进行后续的接口启用、调用与统计等操作。
# 创建应用
- 登录开发者后台,进入 应用管理 页面。
- 点击 创建应用 按钮,填写应用的基本信息。
| 字段 | 说明 |
|---|---|
| 应用名称 | 用于区分不同的应用,例如 我的测试应用。 |
| 应用类型 | 选择应用所属平台,以便平台提供更准确的服务。 |
| 应用详情 | 简要描述应用的用途,便于后续管理与识别。 |
- 点击 创建应用 提交。
- 创建成功后,在 应用管理 页刷新即可看到新创建的应用。
# 调用统计
创建应用后,可在应用列表中点击 当前剩余调用 或 当前累计调用,查看该应用近期接口调用的统计数据,便于掌握调用量变化、评估剩余额度消耗情况。
# 应用配置
在应用的配置页中,可完成以下关键配置:
| 配置项 | 说明 |
|---|---|
| 获取应用密钥 | 用于接口入参及响应参数进行签名验证的密钥(AppSecret)。请妥善保管,避免泄露;如不慎泄露,请及时重置。 |
| 获取调用次数 | 平台运营需要庞大的服务器资源,并持续提供免费调用次数。我们通过小程序或 App 借助广告联盟获取收益,以维持服务的持续运行,希望您能够理解。 |
| 配置数据源信息 | 配置模块 API 所依赖的数据源连接信息,详见下文 数据源配置。 |
| 接口启用快速入口 | 提供前往 API 启用页面的快捷入口,可直接跳转完成接口启用。 |
# 数据源配置
数据源信息非常重要:模块 API 中所需的数据源是使用该模块 API 的必须数据源。使用模块 API 前,需在 配置数据源信息 中完成连接信息配置,否则接口无法正常访问业务数据。
数据源配置提供两种方式,可根据数据源的部署情况选择:
# 直连模式
由氦闪中台直接连接您的数据源,需要您提供完整的数据源连接信息。
- 在 配置数据源信息 中选择 直连模式。
- 填写数据源的连接 URL 及账号、密码。
- 在数据源所在服务器的访问白名单中,添加中台数据访问服务器的 IP。
重要:若未将中台数据访问服务器的 IP 加入数据源所在服务器的白名单,中台将无法连接您的数据源,接口调用会失败。
# 边缘网关模式
由部署在您侧服务器上的边缘网关转发数据访问请求,无需配置任何数据源信息。
- 在 配置数据源信息 中选择 边缘网关模式。
- 在对方服务器(即数据源所在服务器)上拉取
hiasoon/hiasoon-edge-gateway镜像。 - 启动容器并完成相关配置信息。
提示:边缘网关模式无需暴露数据源连接信息,也无需配置中台 IP 白名单。具体操作步骤请详见 HEG 使用指南。
# 网络访问策略
可对接口访问的来源公网 IP 进行白名单控制,降低密钥泄露后被滥用的风险。
- 在 网络访问策略 中添加需要放行的来源公网 IP。
- 输入 IP 后按回车即可保存并立即生效。
- 未在白名单内的来源将无法调用该应用的接口。
提示:建议仅放行实际调用来源的固定公网 IP;来源 IP 发生变化时,需及时同步更新白名单,否则调用将被拒绝。