跳到主要内容

快速开始

本指南从零开始介绍如何为你的平台接入 iCCandle。请按顺序完成以下五个步骤 — 每一步都建立在前一步之上。

完成后你将拥有：

  • Uptech manager（平台管理后台）账号
  • 一个 API 密钥，平台下所有经纪商共用
  • 每个经纪商通过各自的 identifier 接入
  • 终端用户在正确的经纪商下登录，以及每个经纪商用于管理这些用户的 Web 界面
信息

文中会反复出现的两个术语

  • API 密钥 — 用于证明请求来自你平台的密钥字符串。只需创建一次，所有经纪商共用。

  • Identifier — 你为每个经纪商自行选定的唯一 ID 或名称（例如 A broker）。在共用的 API 密钥下，它告诉 iCCandle 用户或管理页面属于哪家经纪商。每个经纪商必须使用不同的 identifier（最短 4 个字符，最长 32 个字符）。

    你不必在管理后台手动创建 identifier。只要该 identifier 首次与你的 API 密钥一起使用，iCCandle 就会在你的平台上自动创建对应经纪商，方式有两种：

    1. 无缝认证 — 后端在登录请求体中传入 identifier（get-user-token-sub-org）。
    2. 管理嵌入页 — 打开 manage.iccandle.site 时通过 URL 查询参数传入 identifier（?apikey=…&identifier=…）。

    两处必须使用同一个 identifier 字符串，这样用户与经纪商的管理页面才会关联在一起。

    建议： 使用你系统中每个经纪商自己的唯一值（例如经纪商 ID 或编码）作为 identifier，这样既稳定又便于映射回对应经纪商。

步骤 1 — 登录 Uptech manager​

  1. 在浏览器中打开 https://manager-uptech.iccandle.site。
  2. 使用 iCCandle 提供给你的用户名和密码 登录。你无需自行注册账号 — 若尚未收到凭证，请联系 iCCandle。

这是你的控制中心。步骤 5 中还会回到这里管理经纪商。

详情：管理

步骤 2 — 创建 API 密钥（仅一次）​

  1. 登录后，打开仪表盘中的 API Keys 选项卡。
  2. 创建新的 API 密钥 — 步骤 3 和 4 中都会用到。
警告

只创建一次，在所有经纪商中复用。 整个平台只需要 一个 API 密钥。不要为每个经纪商分别创建密钥。所有经纪商使用同一把密钥；经纪商之间通过 identifier（下一步）区分，而不是不同的密钥。

请妥善保管 API 密钥 — 仅在后端服务器使用，切勿放在公开网站或移动应用中。

详情：API 密钥

步骤 3 — 在各经纪商下为用户登录（无缝认证）​

现在可以用步骤 2 的 API 密钥为每一个经纪商认证终端用户。所有经纪商共用同一把 API 密钥；唯一变化的是 identifier，它告诉 iCCandle 该用户属于哪个经纪商。

要让用户登录，你的后端向以下地址发送 POST 请求：

POST https://api.iccandle.ai/seamless/get-user-token-sub-org
X-Api-Key: YOUR_API_KEY
Content-Type: application/json

请求体中传入用户的 email 与经纪商的 identifier：

{
  "email": "tergeluser3@gmail.com",
  "identifier": "A broker"
}

该请求会：

  • 若用户尚不存在，iCCandle 会创建该用户；若已存在，则直接登录。
  • 用户会关联到 identifier 所指定的经纪商 — 上例中，tergeluser3@gmail.com 现在属于 A broker。
  • 响应包含用户的会话令牌，用于为该用户加载 iCCandle 小部件。

若要为另一家经纪商登录用户，发送完全相同的请求：使用同一把 API 密钥，但换成该经纪商自己的 identifier（例如 B broker）。

提示

在此传入一个新的 identifier 时，若该经纪商尚不存在，iCCandle 会在你的 API 密钥所属平台下自动创建。步骤 4 的嵌入 URL 使用相同的 identifier 查询参数时效果相同。

详情：无缝认证（子组织）

步骤 4 — 为每个经纪商提供管理 Web 界面（iframe）​

每个经纪商都需要查看并管理自己的用户。iCCandle 提供现成的网页，你可以用 <iframe> 嵌入到经纪商的站点中。

使用同一把 API 密钥（步骤 2）与该经纪商的 identifier（步骤 3）拼出 URL。二者都是 URL 查询参数 — identifier 用于在该 API 密钥所属平台上创建或选中经纪商：

https://manage.iccandle.site/?apikey=YOUR_API_KEY&identifier=YOUR_IDENTIFIER

例如，经纪商 A broker：

<iframe
  src="https://manage.iccandle.site/?apikey=YOUR_API_KEY&identifier=A%20broker"
  width="100%"
  height="800"
></iframe>

若该 identifier 此前从未与此 API 密钥一起使用过，打开该 URL 时会在你的平台上自动创建经纪商（与步骤 3 的无缝认证请求中传入效果相同）。

在该页面中，经纪商可以：

  • 查看其用户 — 所有在步骤 3 中使用该 identifier 认证的用户
  • 为任意用户分配套餐（Standard、Pro 或 Expert）
  • 查看其 iCCandle 积分包余额 — 可用于分配套餐的剩余额度

因为每个经纪商的 identifier 不同，每个经纪商只能看到自己的用户。

详情：客户 / 经纪商

步骤 5 — 在 Uptech manager 中管理经纪商​

经纪商接入完成后，回到 https://manager-uptech.iccandle.site（步骤 1 的仪表盘）。作为平台所有者，你可以：

  • 为经纪商充值余额 — 向经纪商的 iCCandle 积分包添加额度，以便其在步骤 4 中分配套餐
  • 查看各经纪商的用户数 — 每个经纪商（每个 identifier）下无缝认证用户的数量

详情：为客户充值 · 客户统计

快速清单​

步骤位置操作
1manager-uptech.iccandle.site使用 iCCandle 提供的凭证登录
2API Keys 选项卡创建一个 API 密钥并妥善保存
3你的后端向 get-user-token-sub-org 发送 POST，携带用户的 email + 经纪商的 identifier
4经纪商网站在 iframe 中嵌入 https://manage.iccandle.site/?apikey=…&identifier=…
5manager-uptech.iccandle.site为经纪商充值并查看各经纪商的用户数

相关指南​