个人访问令牌(PAT)为 Fax.Plus API 提供安全、细粒度的访问权限。本指南将引导您根据集成需求创建和管理具有适当权限的令牌。
创建个人访问令牌
访问令牌生成
- 登录您的 Fax.Plus 控制面板:app.fax.plus
- 导航至设置 > 集成 > 个人访问令牌
- 点击“生成新令牌”
令牌配置
生成新令牌时,您需要配置以下内容:
- 令牌名称:选择一个能够描述令牌用途的名称
- 过期时间:设置自定义过期日期(建议:90 天)
注意:定期轮换令牌可以显著降低令牌泄露后被未授权访问的风险。
可用权限范围
选择以下一个或多个权限范围来定义令牌的访问权限:
常规访问
-
fax:all:read- 对所有传真相关操作的只读访问权限- 查看传真、用户、成员和号码
-
fax:all:edit- 对所有传真相关操作的完全访问权限- 管理传真、用户、成员、Webhook 和号码
Webhook 管理
-
fax:webhook:read- 查看 Webhook 配置 -
fax:webhook:edit- 完整的 Webhook 管理能力
传真操作
-
fax:fax:read- 查看传真的权限- 查看发件箱列表、传真文件和报告
-
fax:fax:edit- 完整的传真管理权限- 管理发件箱、文件和传真详情
用户管理
-
fax:use:read- 查看当前用户详情(PAT 所有者) -
fax:user:edit- 更新当前用户详情
购买功能
-
fax:shop:read- 浏览传真号码并查看余额 -
fax:shop:edit- 购买号码
成员访问权限
-
fax:member:read- 查看账户和成员详情 -
fax:member:edit- 管理成员信息
号码管理
-
fax:numbers:read- 列出和查看传真号码 -
fax:numbers:edit- 完整的传真号码管理
安全最佳实践
-
最小权限原则
- 仅授予集成绝对必需的权限范围
- 在不需要写入权限时使用只读权限范围
-
令牌轮换
- 每 90 天轮换一次令牌
- 为令牌轮换设置提醒
- 在旧令牌过期前创建新令牌,以确保服务持续可用
-
令牌管理
- 妥善保管令牌,切勿与他人分享
- 如果令牌泄露,立即撤销
- 将令牌安全地存储在应用程序的配置中
实施建议
- 权限范围选择
- 对于只读操作,请使用
*:read权限范围 - 对于完整管理,请使用
*:edit权限范围 - 如需广泛访问权限,可考虑使用
fax:all:read或fax:all:edit
- 对于只读操作,请使用
- 测试
- 先使用最小权限范围测试您的集成
- 根据需要逐步添加权限范围
- 在应用程序中验证令牌过期的处理逻辑
故障排除
如果您遇到访问问题:
- 确认令牌尚未过期
- 确认您已选择所有必需的权限范围
- 检查令牌是否已被撤销
- 确保您在 API 请求中正确使用了该令牌