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

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

概述

该文档面向的是 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"
    }
}

博客发布评论推送社区

请参考 vcomment 文档。

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

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

调用地址

参数

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

{
    "article": {
        "id": "", 
        "title": "", 
        "content": "", 
        "contentHTML": "", 
        "tags": "tag1,tag2,tag3"
    }, 
    "client": {
        "userName": "", 
        "userB3Key": ""
    }
}

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

社区发布回帖推送博客

请参考 vcomment 文档。

使用须知

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

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

  • 系统公告

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

    39 引用 • 3432 回帖 • 671 关注
  • Rhy
    1 引用 • 152 回帖
  • Sym

    Sym 是一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)系统平台,“下一代的社区系统,为未来而构建”。

    498 引用 • 4495 回帖 • 651 关注
  • B3log

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

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

广告 我要投放

欢迎来到这里!

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

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

    好的,在黑客派与动态博客的博主生成的 id 不会冲突的情况下,讲另一种情况

    同时有两个动态博客的博主都希望连接黑客派,都比较懒,生成规则直接使用了 mysql 的自增 id,这时候就会发生冲突

    想了解下,目前连接黑客派的动态博客多吗~

    1 回复
  • 其他回帖
  • zonghua

    @zonghua 都是 null

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

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

  • 88250
    订阅者 作者

    @DT27 @zonghua @zsx

    从社区同步评论到博客的时候加了一些字段:

    • comment.contentHTML:评论内容, HTML 格式
    • comment.ua:User-Agent,可能为空字符串 ""
    • comment.ip:IP,可能为空字符串 ""
  • someone1101

    @88250 那台主机的 IIS 日志:
    2016-03-12 09:46:45 W3SVC173 xxxxxxxx PUT xxxxxxxxxxxx action=comment 80 - 121.40.*.阿里云的某 IP Java/1.7.0_80 403 1 0 1592 560

    我不是写 Java 的不可能有 Java 日志,那只能是同步过来的嘛……

  • 查看全部回帖