开发者接口

密钥

开通 API 付费套餐后会生成一个密钥,uuid 类型。

API 套餐不同于价格界面的阅读套餐,阅读套餐不允许非 RSS 阅读器用途的程序采集,具体价格请联系客服。

webhook 配置

需要向我们提供一个 url 用以接收数据推送,我们会以 application/json 的 content-type 和 POST 的方式推送文章数据。

支持鉴权参数,会附带在 webhook 参数中一起发送,参数名为 token。

系统在网络异常的情况下可能会重复推送同一篇文章,需要进行唯一性判断避免保存重复文章。

返回 { "error": 0 } 表示数据接收成功。

推送字段:

{
  "token", // 鉴权参数
  "title", // 标题
  "url", // 链接
  "source_url", // 原文链接
  "posted_at", // 发布时间
  "idx", // 文章位置,从 0 开始
  "mid", // 在链接中的文章 mid 参数,注意 mid + idx + account_iid 才能确定一篇文章唯一性
  "author", // 作者
  "summary", // 摘要
  "picture", // 主图
  "content", // 内容
  "content_iid", // 文章在 werss 系统中的唯一数字 id,
  "is_original", // 是否有原创标记
  "account_meta": { // 账号信息
    "name",
    "avatar",
    "description",
    "alias",
    "biz",
    "account_iid",
    "rss_id"
  }
}

API 获取订阅列表

GET /api/v3/developers/subscribes?token=${TOKEN}

返回的参数中 rss_id 用以在主动拉取接口中作为公众号识别 id 使用。

{
  "done": true,
  "error": 0,
  "data": {
    "list": [
      {
        "name": "公众号1",
        "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM6b4wlcQqibMNtOyWMV5PIp9dNknicVFrdicYEgnVr8iafd4w/132",
        "description": "公众号描述",
        "alias": "Dejuhwfch",
        "biz": "3568888514",
        "valid": true,
        "account_iid": 2001784,
        "status": null,
        "rss_id": "9198fea1-667f-498f-93cf-**********",
        "last_posted_at": "2019-11-25T00:30:00.000Z",
        "last_fetched_at": "2019-11-25T07:53:24.000Z",
        "subscribed_at": "2019-11-20T10:55:07.650Z"
      },
      {
        "name": "公众号2",
        "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM78BmnoDpVXRW6iaZM4HqDphcrRJoR8G8kwq2U6CcDics1w/132",
        "description": "公众号描述",
        "alias": "gold1849",
        "biz": "3254358981",
        "valid": true,
        "account_iid": 1262162,
        "status": null,
        "rss_id": "cc636bf9-98f5-4ead-a2f1-**********",
        "last_posted_at": "2019-11-24T22:30:00.000Z",
        "last_fetched_at": "2019-11-25T08:04:33.000Z",
        "subscribed_at": "2019-11-20T10:55:49.817Z"
      }
    ]
  }
}

API 主动拉取最新文章

非实时接口,仅为返回系统保存的最近的 8 篇文章。

如无必要,不需要请求该接口,使用 webhook 可以更快更低成本。

rss_id 为订阅列表返回的每个账号的 rss_id。

GET /api/v3/developers/subscribes/:rss_id?token=${token}

{
  "done": true,
  "error": 0,
  "data": {
    "list": [{
      "title", // 标题
      "url", // 链接
      "source_url", // 原文链接
      "posted_at", // 发布时间
      "idx", // 文章位置,从 0 开始
      "mid", // 在链接中的文章 mid 参数,注意 mid + idx + account_iid 才能确定一篇文章唯一性
      "author", // 作者
      "summary", // 摘要
      "picture", // 主图
      "content", // 内容
      "content_iid", // 文章在 werss 系统中的唯一数字 id
      "is_original" // 是否有原创标记
    }],
    "account_meta": { // 账号信息
      "name",
      "avatar",
      "description",
      "alias",
      "biz",
      "account_iid",
      "rss_id"
    }
  }
}