跳转到内容

快速开始

这一页带你从零接入开放平台:创建 API 账号、生成密钥,再用它完成第一次调用。操作在网页加一个终端里完成,大约五分钟。

  • 一个可以登录的 OhMy.xin 账号(用 Mixin 登录即可)。
  • 一个能发 HTTP 请求的终端或工具 —— 下面的示例用 curl,可以直接复制。

登录 OhMy.xin 网页版,点击右上角的头像打开菜单,选择 开发者 API。

点击 新建 API 账号,填写账号名称(必填)与用途说明(可选),提交后进入账号详情页,页面会显示账号编号、状态与当前的速率限制。

API 账号用来隔离不同的集成或环境 —— 比如给「生产环境」和「测试」各建一个。每个用户默认最多 5 个账号,上限按名下全部账号计算(含已停用的);不再使用的账号可以在详情页停用,但停用只是让它的密钥失效,不会腾出名额。

在账号详情页找到 API 密钥,点击 生成密钥 并为它起个名字(例如「主用密钥」)。

之后密钥列表只显示名称、前缀与末尾几位的脱敏片段,绝不再显示完整明文。每个账号默认最多 10 把有效密钥 —— 这是有意为之,方便你新旧并存、无中断轮换(见下文)。

先试不需要密钥的连通性健康检查:

终端窗口
curl -s https://ohmy.xin/api/v1/health

再用你的密钥做凭证自检(把 omx_live_… 换成刚保存的完整密钥):

终端窗口
curl -s https://ohmy.xin/api/v1/me \
-H "Authorization: Bearer omx_live_xxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"

调用成功会返回统一结构的 JSON,包含你的账号与密钥信息:

{
"data": {
"account": {
"number": "8392014",
"name": "生产环境集成",
"state": "active",
"rate_limit_per_minute": 60
},
"key": {
"name": "主用密钥",
"masked_token": "omx_live_a1b2c3d4••••••••x9y0",
"state": "active",
"last_used_at": "2026-11-15T22:14:12+08:00"
}
},
"meta": {
"request_id": "9f4f2d1e-7c3b-4c68-9f9f-0a1b2c3d4e5f"
}
}

前两个内置接口确认链路通畅。要取到实际数据,调用业务接口即可 —— 它们共用同一套鉴权、限流与分页规则:

终端窗口
curl -s "https://ohmy.xin/api/v1/strategies?limit=2" \
-H "Authorization: Bearer omx_live_xxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
终端窗口
curl -s "https://ohmy.xin/api/v1/lives?limit=2" \
-H "Authorization: Bearer omx_live_xxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"

两个接口都返回数组形式的 data,外加 meta.pagination。当 meta.pagination.has_more 为 true 时,把 meta.pagination.next_cursor 原样作为 cursor 参数传回即可取下一页。全部筛选参数与字段见策略列表与直播列表。

回到 开发者 API 页面并进入对应账号,近期调用记录会列出每一次请求的时间、接口、状态码、结果、耗时与来源 IP,可按密钥、时间范围、接口与结果筛选,页首还有成功 / 失败次数的小结。

记录由平台异步采集,会比请求本身稍晚出现;被 IP 级兜底限流直接拦截的请求不会出现在记录里;明细默认保留 90 天。

密钥支持无中断轮换:

  1. 在同一账号下生成一把新密钥;
  2. 把外部系统里的密钥换成新密钥,确认调用正常;
  3. 在列表里吊销旧密钥 —— 它的下一次请求立即被拒绝。

发现密钥泄露时不用等轮换:直接禁用(之后可再启用)或吊销(永久失效),改动立即生效。

现象 原因与处理
401 unauthorized 凭证缺失、密钥不完整或写错、密钥被禁用/吊销,或所属账号被停用/冻结。出于安全考虑,平台不区分具体原因 —— 先检查密钥是否完整复制、状态是否为「启用中」。
429 rate_limit_exceeded 触发限流。响应头 Retry-After 给出建议等待秒数;账号默认每分钟 60 次。
404 not_found 接口路径不存在。当前开放的接口是 /api/v1/health、/api/v1/me、/api/v1/strategies 与 /api/v1/lives —— 见API 参考。
400 invalid_parameter 查询参数不合法。error.details 会指出出错的参数,可接受的值见对应接口页。
响应里没有 X-RateLimit-* 头 两种可能:Authorization 请求头格式不对(鉴权未通过),或被 IP 级兜底限流拦下 —— 后者的文案是 “Too many requests. Please retry later.”,先看响应文案区分。