跳到主要内容

介绍

面向已经拥有自有图表 UI 的合作方提供的托管结果应用。你通过 iframe 加载 iC Candle,传入 搜索参数,并通过 postMessage 让宿主与嵌入端同步。

此集成没有 npm 包。你的应用负责图表、布局与扫描触发;iframe 负责托管结果 UI、形态追踪、新闻流程、认证与计费。

生产环境基础 URL:

https://embed-iccandle-app.iccandle.ai/{locale}
界面作用
扫描结果由 symbol、res、ref_res、cid、tk、model、temperature 等查询参数驱动的形态搜索 UI
形态追踪/{locale}/pattern 下的追踪与通用形态流程(当前仅旗形可激活)
新闻 / 事件/{locale}/news 下的日历与相似事件流程
认证与计费登录发生在 iframe 内;Stripe 结账返回到你的父页面 origin

前提条件​

要求说明
宿主页面需要一个可在图表旁边或下方渲染 iframe 的页面
图表集成你自己的图表实现,能够响应选择、回放与新闻事件
扫描 API 访问若由宿主发起扫描,请把 auth.signIn 返回的 idToken 存为 iccandle_token,并用 Bearer token 调用 cacheCandle

快速开始​

<iframe
id="iccandle"
src="https://embed-iccandle-app.iccandle.ai/zh?theme=light&header=false"
title="iC Candle"
allow="clipboard-write; payment"
style="width: 100%; height: 100%; border: 0;"
></iframe>

路径中的语言可使用 /en、/zh 等,theme 可选 light、dark 或 system;宿主已提供导航时可加 header=false 隐藏嵌入顶栏。

不要以会阻止弹窗或顶层导航的方式 sandbox iframe,因为登录与 Stripe Checkout 都依赖它们。

何时使用​

场景包 / 入口
React + TradingView Charting LibraryReactJS 组件 — 已为你接好扫描器浮层与 iframe
Vue + TradingView Charting LibraryVueJS 组件 — 已为你接好扫描器浮层与 iframe
自有图表 / 框架Iframe 嵌入 — 你自行构建宿主 UI 并驱动 iframe URL

典型流程​

  1. 嵌入 https://embed-iccandle-app.iccandle.ai/{locale}?theme=…。
  2. iframe 加载后,将父页面 origin 发送给嵌入端,以便计费流程在 Stripe 结账后回到你的域名。
  3. 用户在 iframe 内登录;监听 auth.signIn,若宿主会调用扫描 API,将 data.idToken 存为 iccandle_token。
  4. 扫描时:将所选 K 线 POST 到 cacheCandle,再用 cid 与其他搜索参数设置 iframe src。
  5. 处理嵌入端发给父页面的消息,例如 chart.play、chart.stop、形态选择与新闻事件,来更新你的图表。

语言​

路径段 {locale} 可选:en、zh、vi、th、ko、ja、mn、ru(默认 en)。

近期嵌入变更​

变更合作方需知
顶栏开关传 header=false 可隐藏嵌入应用顶栏及其分隔线
搜索结果 UI重新设计的扫描结果面板、匹配图表、文章/事件详情弹窗与 AI 走势控件
AI 扫描提示可选 model(light | pro)与 temperature(0.5 | 1 | 1.5)供结果 UI 使用
通用形态仅看涨/看跌旗形(flagbull / flagbear)可激活;其他通用形态已禁用,深链会重定向
聊天外观形态 AI 聊天输入区使用主页面背景,与结果面板融合

下一步​

  • 开始使用 — iframe 引导、父 origin 握手、认证、cacheCandle 与扫描 URL
  • 搜索参数 — 扫描流程所需与可选的 iframe 查询参数
  • 窗口消息 — 父页面 / 嵌入端消息目录与路由建议
  • 数据类型 — K 线、回放、新闻与认证等共享载荷
  • API 参考 — 查询参数、路由与协议细节