思源笔记本地API介绍:与浏览器和第三方软件交互的超强方案

思源作为一个超级强大的本地优先的笔记软件,自然为用户提供了多种方案让数据快速发送到思源中。

如果你想几句话了解思源的本地API,可以看看知识博主吕立青对思源笔记 API 的评价

  • 云端 API
  • 本地 API

这篇文章将着重讲述思源备受好评的本地 API 功能,但在这之前简单介绍下云端 API。

云端 API(收集箱)

云端 API 主要场景就是在不开启思源的情况下,向你的账号发送一些内容。因为它是需要持续支出的云服务,所以是订阅用户的专属特性。

不过不用担心你会错过什么好用的功能,云端 API 的功能并不多,思源社区也基本都是围绕本地 API 在进行开发。

  • 有哪些功能使用了云端 API

官方并没有提供自行部署云端 API 的功能,不过话又说回来,如果你有自行部署云端 API 的条件,那不如自行部署思源笔记,然后直接使用它的本地 API

本地 API

:sparkles: 本地 API 算是思源笔记中非常重要的特性,对大部分用户来说,只需要知道 本地 API 能做什么,以及它是如何使用的。本地API旨在让用户在使用外部软件时,也可以与思源的知识库进行数据交互(也可以做到跨设备)。

  • 比如同一个wifi下,在手机上直接将网页剪藏到电脑上已开启的思源知识库。

注意

  1. 它其实可以算作是思源的 WebAPI/网络伺服的一部分,但这里为了方便理解,就单独提出来了。
  2. 浏览器扩展、油猴脚本、第三方应用等我都统称为外部软件

如果你想试用体验思源的API,或者了解思源的API开发文档,可以在以下网站找到

交互式体验思源API需要自己开启思源,大部分API需要填入API token


API 地址的获取

API 地址可以在 设置 > 关于 > 在浏览器中使用 中获取

  1. 如果你是在同一个设备中打开思源并使用 API,那就是 http://127.0.0.1:端口号
  2. 如果你是在一个设备中打开思源,然后在同一局域网下的其他设备中使用 API,那就是 http://192.168.xxx.xxx:端口号
  3. 如果你的思源笔记是部署在云服务器中,或是外出使用,则是 公网地址:端口号

API token 的获取

思源的本地 API token 可以在 设置 > 关于 中获取,你也可以在右侧输入框中设置自定义 token

API token 的使用

使用方法非常简单

  1. 打开支持思源 API 的外部软件
  2. 填入 API地址API token
  3. 根据所使用的软件填写一些自定义信息,比如说用哪个笔记本啊、放在哪里啊之类的

1 个赞