Skip to content
On this page

快速入门

利用 API,你可以轻松地将 hamsterbase 和其他工具进行集成。本篇教程将通过以下三个部分,详细解析 hamsterbase 的 API 功能:

  1. 如何启动 API 服务器
  2. 如何获取 Entrypoint
  3. 如何生成 API token

启动 API 服务器

  1. 点击设置图标,进入设置页面。
  2. 找到并点击“API”选项卡。
  3. 点击“启动 API 服务器”按钮。

完成以上步骤后,API 服务器就成功启动了。此时,你可以在其他设备上访问 hamsterbase 并进行交互。

获取 Entrypoint

Entrypoint 实际上是你的电脑在局域网中的地址。你只需点击“复制 Entrypoint”按钮,即可将 Entrypoint 复制到剪贴板。

您可以在浏览器里访问 Entrypoint , 可以访问网页版的 HamsterBase。

生成 API Token

有了 Entrypoint,你就可以在其他设备上访问 hamsterbase 了。但注意,你还需要一个 API token 才能访问 hamsterbase 的 API。你可以通过以下步骤手动生成 API token:

  1. 输入你的 API Token 名称。
  2. 点击“生成密钥”按钮。
  3. 如果是桌面版的 HamsterBase , 需要重启一下服务器。
  4. 点击“复制”按钮,你将得到一个类似于 XZ89RYR-AQ04V8V-M75Y88P-DNXSRCB 的 API Token。

总结

本篇教程详细介绍了 hamsterbase 的 API 功能。你可以通过 API 服务器,将 hamsterbase 和其他工具进行集成。同时,你还可以通过 Entrypoint 和 API token,访问 hamsterbase 的 API。

  • Entrypoint 的格式类似于 http://192.168.80.10:7858

    默认的 Entrypoint 将采用设备所在的局域网的 IP 地址,因此在不同的局域网环境下,IP 地址可能会有所变化。然而,你可以选用 http://localhost:port 或者 http://127.0.0.1:port 来替代默认的入口点,这两个地址始终指向你的本地设备。

    注意,输入 Entrypoint 时,不能以 / 结尾。

  • API Token 的格式类似于 XZ89RYR-AQ04V8V-M75Y88P-DNXSRCB