个人访问令牌 (PATs) 提供安全的、精良的访问 Fax.Plus API。 本指南将使您走过创建和管理令牌的过程,并为您的集成需要提供适当的权限。
创建个人访问令牌
访问令牌生成
- 登录到您的Fax.Plus 仪表板: app.fax.plus
- Navigate to Profile > Integrations > Personal Access Tokens
- 点击"生成新令牌"
令牌配置
生成新令牌时,您需要配置:
- 代币名称:选择一个描述性的名称来识别代币的目的
- 过期:设置自定义过期日期(推荐:90天)
注意: 常规令牌旋转大大降低了如果令牌被破坏时未经授权访问的风险。
可用范围
选择一个或多个范围来定义令牌的访问权限:
常规访问
-
传真:all:read
- 只读访问所有与传真有关的操作- 查看传真、 用户、 成员和数字
-
传真:all:edit
- 完全访问所有与传真有关的操作- 管理传真、 用户、 会员、 网络钩子和数字
Webhook 管理
-
fax:webhook:read
- 查看 webhook 配置 -
fax:webhook:edit
- 完整的 webhook 管理功能
传真操作
-
传真:fax:read
- 查看传真的权限- 查看发件箱列表、传真文件和报表
-
传真:fax:edit
- 完整传真管理权限- 管理发件箱、文件和传真详细信息
用户管理
-
传真:use:read
- 查看当前用户详细信息 (PAT所有者) -
传真:user:edit
- 更新当前用户详细信息
商店功能
-
传真:shop:read
- 浏览传真号码并检查余额积分 -
传真:shop:edit
- 购买号码
成员访问权限
-
传真:member:read
- 查看帐户和会员详细信息 -
传真:member:edit
- 管理会员信息
号码管理
-
fax:numbers:read
- 列出并查看传真号码 -
fax:nums:edit
- 完整的传真号码管理
安全最佳做法
-
最少特权原则
- 只授予您的集成绝对必要的范围
- 不需要写权限时使用只读范围
-
令牌旋转
- 每90天旋转令牌
- 设置令牌旋转提醒
- 在旧代币到期前创建新代币以确保连续服务
-
代币管理
- 保持令牌安全,永远不会分享它
- 损坏时立即撤销令牌
- 在应用程序的配置中安全存储令牌
执行提示
- 范围
- 只读操作,使用
*:read
范围 - 如需全面管理,请使用
*:edit
范围 - 考虑使用
传真:all:read
或fax:all:edit
以满足广泛的访问需要
- 只读操作,使用
- 测试
- 首先测试你在最小范围内的集成
- 按需要逐渐添加范围
- 在您的应用程序中验证令牌过期处理
故障排除
如果您遇到访问问题:
- 验证令牌尚未过期
- 确认您已经选择了所有必需的范围
- 检查令牌是否被吊销了
- 请确保您在 API 请求中正确使用令牌。