跳到正文
Indiana
控制台
开发文档
章节目录 / 全部接口

全部接口

每个 HTTP 操作的路径、凭据、权限、SDK 方法与说明，以及 Funnel 命令和公开接口。

API v1更新于

概览

共 84 个普通操作，其中 78 个可用、6 个保留接口返回 HTTP 501；另有 25 个 Funnel 命令和 6 个公开配置与实验接口。每个操作都按凭据、权限与 App／环境作用域执行。

  • 点击接口查看请求示例、请求体参数、响应字段与对应的 SDK 方法。
  • JavaScript SDK 的方法名与操作名相同：Server Key 操作在 createIndianaServer 上，Customer Token 操作在浏览器的 createIndiana 上。

Customer、访客与会话

权益与商品展示

余额、用量与账本

席位

订阅与支付

发票、退款与计费

优惠券、奖励与推荐

Feature、求值与事件

原生购买

AI 定价

CLI 与 CI

Funnel 命令

全部发送到 POST /api/v1/funnels，由 JSON 字段 operation 选择。Server Key 启动 Run 与服务端命令需要 funnels:run 和 sessions:create；用 externalUserId 创建 Customer 还需要 customers:write。

Funnel 命令
operation凭据说明
startServer Key 或 Customer Token在固定的 Funnel Version 启动 Run，返回 Run Token。
getRun Token + 原身份证明读取 Run 与当前指令。
resumeRun Token + 原身份证明恢复原 Run，保留已受理的工作与等待。
submitRun Token + 原身份证明提交当前界面的输入。
backRun Token + 原身份证明在允许的位置返回上一步。
shownRun Token + 原身份证明记录界面已实际展示。
closeRun Token + 原身份证明按停止规则关闭交互。
commit_segmentRun Token + 原身份证明提交 Local 模式的一段纯计算步骤，由服务端复核。
evaluateRun Token + 原身份证明Local 模式的单节点求值回报；新集成使用 commit_segment。
reviewRun Token + 原身份证明读取历史展示或回执，不恢复执行。
decideServer Key为指定 Customer 与属性请求后端决策。
read_decisionServer Key按 decisionId 读取原决策。
evaluate_decisionServer Key为原决策提交一次纯求值结果。
feature_configServer Key读取允许下载的 Feature 配置。
commit_decision_segmentServer Key提交原决策的 Local 步骤。
segment_configurationServer Key读取已发布版本的求值片段。
configurationServer Key读取 Funnel 配置，核对版本与求值模式。
local_configurationServer Key读取 Local SDK 使用的配置。
report_usedServer Key记录调用方报告的采纳，按 eventId 去重。
campaign_decideServer KeyCampaign 决策。
campaign_startServer Key按冷却时间启动 Campaign，或返回抑制原因。
renew_runServer Key轮换 Run Token。
signalServer Key向等待中的 Run 提交外部事件。
read_resultsServer Key读取 Run 已受理的结果。
resolve_screenServer Key 或已识别的 Customer Token解析 Local 界面需要的资源状态与优惠摘要。

Funnel 命令

  • start

    凭据
    Server Key 或 Customer Token
    说明
    在固定的 Funnel Version 启动 Run，返回 Run Token。

  • get

    凭据
    Run Token + 原身份证明
    说明
    读取 Run 与当前指令。

  • resume

    凭据
    Run Token + 原身份证明
    说明
    恢复原 Run，保留已受理的工作与等待。

  • submit

    凭据
    Run Token + 原身份证明
    说明
    提交当前界面的输入。

  • back

    凭据
    Run Token + 原身份证明
    说明
    在允许的位置返回上一步。

  • shown

    凭据
    Run Token + 原身份证明
    说明
    记录界面已实际展示。

  • close

    凭据
    Run Token + 原身份证明
    说明
    按停止规则关闭交互。

  • commit_segment

    凭据
    Run Token + 原身份证明
    说明
    提交 Local 模式的一段纯计算步骤，由服务端复核。

  • evaluate

    凭据
    Run Token + 原身份证明
    说明
    Local 模式的单节点求值回报；新集成使用 commit_segment。

  • review

    凭据
    Run Token + 原身份证明
    说明
    读取历史展示或回执，不恢复执行。

  • decide

    凭据
    Server Key
    说明
    为指定 Customer 与属性请求后端决策。

  • read_decision

    凭据
    Server Key
    说明
    按 decisionId 读取原决策。

  • evaluate_decision

    凭据
    Server Key
    说明
    为原决策提交一次纯求值结果。

  • feature_config

    凭据
    Server Key
    说明
    读取允许下载的 Feature 配置。

  • commit_decision_segment

    凭据
    Server Key
    说明
    提交原决策的 Local 步骤。

  • segment_configuration

    凭据
    Server Key
    说明
    读取已发布版本的求值片段。

  • configuration

    凭据
    Server Key
    说明
    读取 Funnel 配置，核对版本与求值模式。

  • local_configuration

    凭据
    Server Key
    说明
    读取 Local SDK 使用的配置。

  • report_used

    凭据
    Server Key
    说明
    记录调用方报告的采纳，按 eventId 去重。

  • campaign_decide

    凭据
    Server Key
    说明
    Campaign 决策。

  • campaign_start

    凭据
    Server Key
    说明
    按冷却时间启动 Campaign，或返回抑制原因。

  • renew_run

    凭据
    Server Key
    说明
    轮换 Run Token。

  • signal

    凭据
    Server Key
    说明
    向等待中的 Run 提交外部事件。

  • read_results

    凭据
    Server Key
    说明
    读取 Run 已受理的结果。

  • resolve_screen

    凭据
    Server Key 或已识别的 Customer Token
    说明
    解析 Local 界面需要的资源状态与优惠摘要。

相关：Funnel 决策 HTTP

公开配置与网页实验

无需凭据的公开接口
方法路径说明
GET/api/v1/configuration/{environmentId}已发布的 SDK 公开配置清单；支持 ETag／304。
GET/api/v1/configuration/{environmentId}/artifacts/{digest}清单引用的公开配置文件，按 SHA-256 校验。
GET/api/v1/page-experiments/{environmentId}URL 跳转实验配置。
POST/api/v1/page-experiments/{environmentId}/eventsURL 跳转实验的曝光与事件；校验 Origin。
GET/api/v1/visual-experiments/{environmentId}可视化实验配置。
POST/api/v1/visual-experiments/{environmentId}/events可视化实验的曝光与事件；校验 Origin。

无需凭据的公开接口

  • GET

    路径
    /api/v1/configuration/{environmentId}
    说明
    已发布的 SDK 公开配置清单；支持 ETag／304。

  • GET

    路径
    /api/v1/configuration/{environmentId}/artifacts/{digest}
    说明
    清单引用的公开配置文件，按 SHA-256 校验。

  • GET

    路径
    /api/v1/page-experiments/{environmentId}
    说明
    URL 跳转实验配置。

  • POST

    路径
    /api/v1/page-experiments/{environmentId}/events
    说明
    URL 跳转实验的曝光与事件；校验 Origin。

  • GET

    路径
    /api/v1/visual-experiments/{environmentId}
    说明
    可视化实验配置。

  • POST

    路径
    /api/v1/visual-experiments/{environmentId}/events
    说明
    可视化实验的曝光与事件；校验 Origin。