氦闪中台文档

# 🚀 开始接入

本文档将引导您在 10 分钟内，完成从注册到成功调用第一个 API 的全过程。

# 目标

在本节结束时，您将能够：

  • ✅ 拥有一个开发者账号和应用。
  • ✅ 理解氦闪中台的基本调用流程。
  • ✅ 成功调用测试接口，并看到调用结果。

# 第一步：注册开发者账号

  1. 访问 氦闪开发者控制台 (opens new window) 。

  2. 选择 “注册” （若已有账号，则直接登录）

  3. 按照引导填写邮箱、手机号等信息完成注册和实名认证。

提示：注册成功后，登录进入后台。

# 第二步：创建您的第一个应用

应用（App）是您调用 API 的凭证载体。所有 API 调用都需要通过特定的 Appid 和 AppSecret 进行鉴权和验签。

  1. 在开发者后台首页，点击 “创建应用” 按钮。
  2. 填写应用的基本信息：
    • 应用名称：例如 我的测试应用
    • 应用类型：选择您的应用平台，以便提供更准确的服务。
    • 应用详情：简要描述您的应用用途。
  3. 点击 “创建应用”。
  4. 创建成功后，在 应用管理页刷新即可看到新创建的应用
  5. 点击 “应用配置”，依次获取密钥、调用次数、配置数据源
  6. 点击 “立即挑选启用需要的API”，前往API启用页面

重要：AppSecret 仅显示一次，请立即保存到安全的地方。

# 第三步：配置接口权限

出于安全考虑，每个应用默认未启用任何接口。您需要为您创建的应用授权，启用所需的接口。

  1. 在平台接口页，在 “请选择您的应用” 下拉选选中刚刚创建的应用。
  2. 选择 “单体API”，点击 测试获取静态数据” 测试接口。
  3. 在右侧弹出的抽屉中，点击右上角 “开启”。

重要说明：此测试接口无数据源需求，也无需进行验签和唯一性验证，在连接验证成功后请立即关闭此接口的调用权限！以免造成您的调用次数被截取消耗。

# 第四步：调用 API 进行测试

现在，让我们使用 cURL 命令来测试用户注册接口，验证一切是否正常。

# 请求示例

将以下命令中的 YOUR_APPID 和 YOUR_APPSECRET 替换为第二步中获取的实际值。

curl -X POST "https://lb/business-service/init-test/api/v1/getInitData" -H "Content-Type: application/json" -H "Appid: YOUR_APPID" -d "{\"type\": \"developer\"}"

# 预期响应

如果调用成功，您将收到一个类似以下的 JSON 响应：

{
    "code": 200,
    "message": "操作成功",
    "data": {
        "result": "成功获取到数据",
        "appid": "来源：APPID_XXXX",
        "option": "获取数据"
    },
    "info": null
}

# 验证结果

调用成功后，您可以返回开发者后台，在 “应用管理” 或 “系统管理” 的 “日志审计” 看到刚刚的调用记录。这证明您的接入已成功！

# 🎉 恭喜您！

您已经成功完成了氦闪中台的初步接入！接下来，您可以：

←