身份验证⚓︎
本指南包含有关通过 FreeFlarum 的 API 而不是 Flarum 进行身份验证(登录到 FreeFlarum 设置)的详细信息 。
如果您有需要,我们还准备了 FreeFlarum Python 包。
忘记密码?⚓︎
FreeFlarum 的登录表单需要与您的论坛管理员帐户密码相同的密码哈希。 这意味着如果您忘记了密码,您可以在您的论坛上重置它:
1.确保您已注销(您可以使用隐身/隐私浏览); 2. 在您的 Flarum 论坛点击“登录”按钮; 3. 点击底部的“Forgot password?”按钮; 4. 输入您的管理员邮箱; 5. 按照发送到该电子邮件地址的说明重新设置您的密码; 6. 之后,您可以使用这个新密码登录 FreeFlarum。
访问令牌⚓︎
如果您访问了 FreeFlarum 上的帐户设置,您可能已经注意到我们列出了您的所有访问令牌。
每次成功登录您的 FreeFlarum 论坛帐户时都会创建访问令牌。 外部应用可以使用它们代表您的帐户执行操作(例如:下载您的论坛数据、链接您的域、修复您的论坛、获取您的论坛信息等)。
您可以使用您的访问令牌之一使用第三方迁移服务,他们可以获取您的论坛数据并为您迁移您的论坛。 或者,您可能只是想创建一个个人脚本以在某些条件下访问您的网站。
所有 API 路由都列在 https://api.freeflarum.com/ 上。
具有“高级权限”的访问令牌⚓︎
只有当您通过主网站 (https://freeflarum.com) 登录 FreeFlarum 时,才会创建具有“高级权限”的访问令牌。在主页之外创建的任何登录/访问令牌都不会具有高级权限。
访问令牌的权限表⚓︎
操作 | 普通令牌 | 具有高级权限的令牌 |
---|---|---|
获取论坛信息(标签、电子邮件等...) | ✅ | ✅ |
获取 FoF 上传限制 | ✅ | ✅ |
修复论坛 | ✅ | ✅ |
链接自定义域 | ✅ | ✅ |
获取(可用)服务器日志 | ✅ | ✅ |
导出您的论坛数据(也可导出为 CSV) | ✅ | ✅ |
撤销其他访问令牌 | ❌ | ✅ |
删除您的论坛 | ❌ | ✅ |
出于安全考虑,只有在您通过 FreeFlarum 主网站登录时,您才可以删除您的论坛并撤销其他访问令牌。
但是,如果您复制具有高级权限的令牌并在 FreeFlarum 之外使用它,它仍将具有高级权限。 建议您通过普通令牌使用第三方服务。
"Remember me"⚓︎
默认情况下,登录 FreeFlarum 时不会勾选“记住我”选项,因此您的访问令牌将在 1 小时后过期。 我们建议对一次性的第三方服务(如果他们在 1 小时内完成任务)这样做,这样 1 小时后令牌就不再有效。
如果您勾选“记住我”框,则令牌将永远有效换句话说,除非删除 access_token
cookie(例如:清除浏览历史记录后)否则您不会被注销。
创建新的访问令牌⚓︎
您有 2种方式来创建访问令牌:
- 通过FreeFlarum官网登录创建
- 向 https://api.freeflarum.com/authentication 发送 API 请求
如果您无法创建 API 请求或者您根本不是技术人员,但需要某些第三方服务的访问令牌,那么我们推荐使用第一种方法。
如果要在保持登录状态时这样做,请打开一个新的无痕窗口(隐私标签页)或通过不同的浏览器/设备访问 FreeFlarum。然后,在不勾选“Remember me”框的情况下登录,您将得到一个临时(1 小时)令牌,但具有 高级权限。如果您不想要高级权限,那么您需要通过 api.freeflarum.com 进行身份验证或发起 API 请求。
第二种方法非常适合在没有高级权限的情况下获取令牌,并在 API 文档 中进行了描述。
撤销访问令牌⚓︎
同样,您有 2 个选项:
- 登录 FreeFlarum.com 并点击访问令牌左侧的垃圾桶图标将其撤销;
- 使用具有高级权限的访问令牌并发送 API 请求。
请注意,更改论坛管理员的密码不会撤销现有的访问令牌(这是由于技术限制——FreeFlarum 的 Python 后端无法与 Flarum 的 PHP 后端通信)。
如果您由于安全原因更改密码(例如:未经授权使用您的令牌或密码泄露),您将需要手动撤销所有现有的访问令牌(请参阅上面的可用方法)。