公共 API

开发者

公共 API

通过简单的密钥认证 API 读取你的网站、报告、排名和关键词。Agency 功能。

公共 API

公共 API 提供对 RankMeFast 已为你的账户保存的数据的只读访问——网站、最新审计报告、排名历史和已跟踪的关键词。这是 Agency 套餐功能(参见套餐、限额与积分)。该 API 绝不会触发新的供应商调用——它只读取审计和排名检查已经产生的数据。

认证

账户 → API 密钥/profile?tab=api-keys)中创建密钥。完整密钥只显示一次——请立即复制;此后只能看到其前缀。你最多可以持有十个有效密钥,并可随时吊销任意一个。被吊销的密钥立即失效。

在每个请求中以 bearer 令牌形式发送密钥:

Authorization: Bearer rmf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

将下方示例中的 https://your-rankme-host 替换为你的 api 源地址(即安装的 SERVER_URL)。

端点

列出你的网站

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites

返回 { "sites": [{ "id", "domain", "url", "createdAt" }] }

网站的最新审计报告

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites/<siteId>/report/latest

{ "runId", "report" } 形式返回最近一次成功的审计——与控制台显示的发现、分类和本地化文案完全一致。若该网站还没有完成的审计,返回 404

网站的排名历史

curl -H "Authorization: Bearer rmf_..." \
  "https://your-rankme-host/api/v1/sites/<siteId>/rank-history?from=2026-06-01&to=2026-07-01"

返回 { "keywords": [{ "id", "phrase", "series": [...] }] }。每个数据点包含排名位置、上榜 URL 以及 Google AI Overview 信号(aiOverviewPresentaiCitedaiCitedUrl)。fromto 为可选的 ISO 日期。

所有已跟踪的关键词

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/keywords

返回你所有网站中每个已跟踪关键词的最新排名、变化值和 AI Overview 字段。

速率限制

默认情况下,每个密钥每分钟最多 120 个请求。超出后 API 返回 429,直到窗口重置。

错误

错误采用 { "error": { "message": "...", "details": ... } } 形式,并根据你的 Accept-Language 请求头本地化:

  • 401 —— 密钥缺失、格式错误、已吊销或未知。
  • 402 —— 你的套餐不包含 API。
  • 404 —— 该网站或报告不存在于你的账户中。
  • 429 —— 超出速率限制(响应体:{ "error": "..." })。

兼容性

此版本只提供以下四个只读路由:

  • GET /api/v1/sites
  • GET /api/v1/sites/:siteId/report/latest
  • GET /api/v1/sites/:siteId/rank-history
  • GET /api/v1/keywords

品牌雷达、评论智能、链接智能、流量洞察、关键词趋势和 SERP 传感器均未在 /api/v1 下新增路由。五项付费功能仍通过需要认证的控制面板提供;公共传感器仍位于 /api/volatility。现有响应字段的含义保持不变,客户端应忽略无法识别的增量字段。

<!-- public-api-routes: GET /api/v1/sites; GET /api/v1/sites/:siteId/report/latest; GET /api/v1/sites/:siteId/rank-history; GET /api/v1/keywords -->

返回文档索引