开发者文档

安装并接入

需要管理员签发的 API Key（rkl_live_ 开头）。 客户无需登录控制台，拿到密钥即可调用。

pip install "git+https://github.com/LordFoxFairy/RankLoop.git#subdirectory=sdk/python"

from rankloop import Client, PublishBlockedError

client = Client(api_key="rkl_live_xxx")
content = client.submit(site_id, path="/posts/hello", body=html)

try:
    client.publish(content.id)
except PublishBlockedError as e:
    print(f"当前 {e.score} 分，必须先修：{e.blocking}")

批量场景

不想为每条内容写 try/except 时，用 publish_when_ready 取回待修复项，每项都带修复建议与预估耗时。

ok, todo = client.publish_when_ready(content.id)
for r in todo:
    print(r.message, r.recommendation, f"约 {r.minutes} 分钟")

1 · 获取 API Key

在控制台创建。明文只显示一次，请立即保存。

Authorization: Bearer rkl_live_xxxxxxxxxxxx

2 · 提交内容

支持 HTML 与 Markdown。Markdown 的元数据通过 frontmatter 提供。

curl -X POST "https://你的域名/api/v1/sites/{siteId}/contents" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"/article","format":"markdown","body":"---\ntitle: 标题\n---\n\n# 正文"}'

3 · 按返回结果修复并发布

检测不通过时返回规则编码、触发证据与修复建议，据此修改后重新提交。

{ "score": 0, "publishable": false,
  "issues": [{ "code": "MISSING_TITLE",
               "evidence": "title 为空或未提供",
               "recommendation": "添加 10-60 字符的标题，包含核心关键词。" }] }