跳转到内容

开放平台

OhMy.xin 开放平台把平台的部分能力以 API 的形式开放给外部系统:你在网页上自助创建 API 账号 与 API 密钥,然后用自己的程序调用统一规范的开放接口。

鉴权、速率限制、统一的响应与错误格式、调用记录 —— 这些公共部分全部由平台承担,你只需要关心业务本身。

统一接入框架提供了两个服务接口:

  • 连通性健康检查(GET /api/v1/health)—— 不需要密钥,用来确认服务可达。
  • 凭证与账号自检(GET /api/v1/me)—— 用密钥调用,确认凭证有效并查看账号与密钥信息。

其上已经有两个业务接口可用:

  • 策略列表(GET /api/v1/strategies)—— 公开可见的交易策略,可按圈子、标的、方向与时间窗口筛选。
  • 直播列表(GET /api/v1/lives)—— 公开可见的圈子直播,含状态、观众数与回放可用性。

具体的业务接口会在之后陆续挂载到同一套框架下。新接口自动继承同样的鉴权、限流、分页与错误规范,你的接入代码不需要为它们再做额外适配。

概念 说明
API 账号 接入的主体单元,用来隔离不同的集成或环境(例如「生产环境」和「测试」各一个)。每个用户默认最多 5 个。
API 密钥 调用接口的凭证,挂在某个 API 账号下,以 omx_live_ 开头。明文只在生成时展示一次,之后只显示脱敏片段。每个账号默认最多 10 把有效密钥。
速率限制 每个 API 账号默认每分钟最多 60 次请求;此外对同一来源 IP 的全部 /api/ 流量另有兜底限制(默认 300 次/分钟),不区分凭证是否有效。
调用记录 进入网关处理的每一次请求(包括鉴权失败与触发限流)都会留下结构化记录,可在开发者 API 页面按密钥、时间、接口与结果筛选。默认保留 90 天;被 IP 级兜底限流直接拦截的请求不产生记录。
请求追踪 ID 每个响应都携带唯一的 request_id;排查问题时提供它,平台就能对齐日志。

同一套规范也提供机器可读形式,代码生成器与 LLM 工具调用可以直接消费: