内容 API 开放,欢迎各位独立博客主进行连接

本贴最后更新于 1371 天前,其中的信息可能已经事过境迁

概述

该文档面向的是 B3log 分布式社区博客端节点开发者,如果你只是想开发链滴的客户端,请参考社区客户端 API 文档

B3log 构思

B3log 构思目前已经基本实现, SoloPipe链滴已经可以进行帖子、回帖内容交互:

  • 使用博客发布文章、评论会自动推送到链滴社区
  • 在链滴社区上发布帖子、回帖也可以推送到博客

内容 API

核心内容 API 一共有 2 个。前 2 个 API 由社区实现,提供给博客进行调用;后 2 个由博客实现,提供给社区进行调用:

  1. 博客发布/更新文章 -> 社区发布/更新帖子
  2. 博客发布评论 -> 社区发布回帖
  3. 社区发布/更新帖子 -> 博客发布/更新文章
  4. 社区发布回帖 -> 博客发布评论

其中 2、4 这两个 API 由 vcomment 组件实现。

账号关联

  • 博客通过社区账号登录初始化

如果一切顺利,你的博客账号和社区账号就自动设置了相同的用户名和 B3 Key 了,然后再完成 B3 同步设置就完成关联账号了。

关联账号的核心要义是博客端和社区端的 B3 Key 必须相同,因为后续的数据交互是通过 B3 Key 进行校验的。

API 规范

上面我们介绍了基本原理,下面介绍 API 细节。

博客发布/更新文章推送社区

发布文章和更新文章使用相同的 API,如果 article.id 已经存在则视为更新操作。

调用地址

参数

在 POST body 中指定 JSON 格式的实参:

{
    "article": {
        "id": "1165070220000", 
        "title": "这是一篇测试文章", 
        "permalink": "/test-post", 
        "tags": "Sandbox", 
        "content": "上面请使用 Sandbox 作为标签。"
    }, 
    "client": {
        "title": "我的个人博客", 
        "host": "http://xxx.com", 
        "name": "Solo", 
        "ver": "3.0.0", 
        "userName": "88250", 
        "userB3Key": "xxxx"
    }
}
  • article.id:博客的文章 id,如果该 id 文章在社区已经存在,则视为更新
  • article.title:文章标题
  • article.permalink:博客文章固定链接
  • article.tags:文章标签,英文输入状态的逗号分隔
  • article.content:文章内容,HTML 或 Markdown 格式
  • client.title:博客站点标题
  • client.host:博客站点 URL
  • client.name:博客程序名
  • client.ver:博客程序版本号
  • client.userName:文章作者用户名
  • client.userB3Key:文章作者 B3 Key

博客发布评论推送社区

请参考 vcomment 文档。

社区发布/更新帖子推送博客

接收文章的接口由博客实现,这里给出的是社区去调用时候的规范。

调用地址

  • 调用用户在 B3 设置的 "博客收文接口" 地址
  • 使用 POST 方法

参数

在 POST body 中指定 JSON 格式的实参:

{
    "article": {
        "id": "", 
        "title": "", 
        "content": "", 
        "contentHTML": "", 
        "tags": "tag1,tag2,tag3"
    }, 
    "client": {
        "userName": "", 
        "userB3Key": ""
    }
}
  • article.id:社区帖子 id,如果该 id 帖子在博客已经存在,则视为更新
  • article.title:帖子标题
  • article.content:帖子内容,Markdown 格式
  • article.contentHTML:帖子内容,HTML 格式
  • article.tags:帖子标签,英文逗号分隔
  • client.userName:帖子作者用户名
  • client.userB3Key:帖子作者 B3 Key

注意:从社区同步帖子到博客时,收文接口实现文章保存后不能再走同步回社区的逻辑。

社区发布回帖推送博客

请参考 vcomment 文档。

使用须知

从博客同步文章到社区请注意如下规则:

  • 同步垃圾内容账号会被封禁
  • 同步间隔不能小于 10 分钟

如果遇到不能同步的问题,请检查博客端日志。

  • 系统公告

    B3log 社区相关的重要公告,比如新特性上线,运营策略调整等。

    39 引用 • 3570 回帖 • 678 关注
  • Rhy
    1 引用 • 156 回帖
  • Sym

    Sym 是一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)系统平台。

    下一代的社区系统,为未来而构建

    522 引用 • 4581 回帖 • 687 关注
  • B3log

    B3log 是一个开源组织,名字来源于“Bulletin Board Blog”缩写,目标是将独立博客与论坛结合,形成一种新的网络社区体验,详细请看 B3log 构思。目前 B3log 已经开源了多款产品:SymSoloVditor思源笔记

    1090 引用 • 3467 回帖 • 296 关注
3 操作
88250 在 2020-06-26 13:14:36 更新了该帖
88250 在 2020-03-31 11:57:02 更新了该帖
88250 在 2020-03-08 10:48:03 更新了该帖

相关帖子

优质回帖

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • 88250

    Hi,我们有一个用 React Native 写的客户端,不过目前没时间精力去维护了 😂 如果你想开发客户端,可以参考 https://hacpai.com/article/1488603534762 进行开发。

    1 回复
  • 其他回帖
  • DT27

    @88250 帮我看下评论同步到博客。我直接用下面的 js 模拟是没问题的。但是从社区从不过去内容链接作者都是空白。。。

    $.ajax({
    type: "POST",
    url: "https://dt27.org/b3log-hacpai/comment",
    contentType: "application/json; charset=utf-8",
    data: '{"comment":{"articleId":"1324","content":"评论 test","authorName":"DT27","authorEmail":"dt27@dt27.org","authorURL":"https://dt27.org"},"client":{"key":"XXXXXXXX"}}',
    dataType: "json",
    success: function (message) {
    if (message > 0) {
    console.log(message);
    }
    },
    error: function (message) {
    console.log(message);
    }
    });

  • 88250

    @zsx

    1. API 校验出错后的返回 succ 字段的值会调整为 false
    2. 调用博客同步评论时的 UA 已加入 B3log Symphony/{ver}
    3. 正文的 MD 处理的确有一些问题,后续会尽力完善
    4. 传入邮箱了,因为社区这边不能确切知道是不是博客站长,这个判断逻辑上走不通
    5. 评论时间这个估计是一致不了的,社区这边是异步处理,会存在一定延时

    多谢达达指出这么多问题,我马上部署一版看看~

  • zonghua

    @zonghua 都是 null

    `function post_article(post_id, post, $update){
    test($update);
    }

    function update_article(post_ID, post_after, $post_before){
    test($post_before);
    }
    `

  • 查看全部回帖