Skip to content

API参考

为注明均为GET请求

/login/check

在登录会话中检查登录状态,响应如下

json
{
    "err": "",
    "data": {
        "isLogin": true,
        // data:image/png;base64,格式的二维码图片数据
        "qrcode": ""
    }
}

/login/code

在登录会话中POST提交验证码,响应如下

json
{
    "err": "",
}

/add/:id?k=xxx

根据公众号ID添加订阅,:id为公众号ID,响应如下

json
{
    "err": "",
    "data": "http://xxx" // 订阅地址
}

添加成功后会提交一个更新任务,获取文章内容,一般在1-3秒内完成,如果触发微信风控,任务会被推迟一定时间后自动重试,详见Q&A 频率限制问题

如果该公众号已经订阅,同样也会触发更新任务,所以不要将这个地址作为订阅地址,避免频繁触发更新

k参数为RSS_TOKEN配置值,如果未设置,则不需要该参数

/addurl?url=https://xxx&k=xxx

/add接口,自动解析文章中的公众号ID

k参数为RSS_TOKEN配置值,如果未设置,则不需要该参数

/del/:id?k=xxx

根据公众号ID删除订阅

k参数为RSS_TOKEN配置值,如果未设置,则不需要该参数

/list?k=xxx

列出所有订阅的公众号

k参数为RSS_TOKEN配置值,如果未设置,则不需要该参数

返回数据为如下JSON格式数据:

json
{
    "err": "",
    "data": [
        {
            "id": 12345,  // 公众号ID
            "name": "XX号", // 公众号名字
            "link": "http://xxx", // 订阅地址
        },
        {
            "id": 12345,
            "name": "XX号",
            "link": "http://xxx",
        }
        ...
    ]
}

/config?k=xxx

k参数为RSS_TOKEN配置值,如果未设置,则不需要该参数

GET获取配置信息,响应如下

json
{
    "err": "",
    "data": {
        "host": "http://xxx",
        ...
    }
}

POST提交配置信息,请求数据格式为上述data数据结构

其中tokensecretproxy_secret字段,GET请求时响应的值为空,POST提交时为空则视为不修改

WARNING

此处修改配置如果和已配置的环境遍历冲突,服务重启后,会恢复为环境变量配置,建议删除环境变量

/feed/:id.xml

RSS订阅地址

默认:id为公众号ID

开启RSS_ENC_FEED_ID后,idHMAC计算后的公众号ID,密码由RSS_SECRET提供

/refresh

清除等待时间,立即刷新内容

关于等待时间可以看Q&A 频率限制问题

/img-proxy?u=http://xx&k=xx

全文输出使用的图片代理

k为验证参数,为uHMAC计算后的8字符前缀,密码由RSS_SECRET提供

/version

查看当前版本