如何设置初始 API 身份验证流程？

更新 2026年09月11日 17:52

谁可以使用此功能？

适用于 Enterprise 套餐。

Web 应用程序中的所有者和管理员均可使用此功能。

要使用 Fax.Plus API，您必须先授权该 API 访问您的账户。完成授权流程后，您就可以登录您的账户。

身份验证有两种不同的方法：

生成并使用个人访问令牌。
使用 OAuth 2.0 流程。

方法一：生成并使用个人访问令牌

个人访问令牌可用作安全访问 Fax.Plus API 的身份验证方法。此令牌相当于一个数字签名，允许您向我们的 API 发出授权请求，从而执行诸如发送传真和检索传真数据等操作。

请按照以下步骤生成新的个人访问令牌：

登录您的Fax.Plus账户，进入仪表盘中的设置部分。
找到集成标签页。
在Fax.Plus API下，找到个人访问令牌项目，点击管理。
点击生成令牌，并指定令牌名称、过期日期和权限范围（在令牌上同时设置编辑和读取权限）。
请务必立即复制您的个人访问令牌，否则您将无法再次查看它。

方法二：使用 OAuth 2.0 流程授权 API 访问您的账户

第一步：设置初始身份验证流程

登录您的Fax.Plus账户，进入仪表盘中的设置部分。
找到集成标签页。
在Fax.Plus API下，点击激活，并收集以下数据：
- 客户端 ID（以 APIK- 开头）
- 客户端密钥
- 重定向 URI（其中之一）
要开始授权 API 访问您账户的流程，只需在浏览器中点击此步骤提供的链接。此链接会将您重定向到一个提示页面，您可以在此授予必要的权限：https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
获得权限后，您将被重定向到您指定的 URL，并附带作为 URL 参数的授权码：

第二步：发送 HTTP POST 请求

成功授权访问后，您可以继续对以下 URL 执行 HTTP POST 操作：https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI]。

请确保在您的请求中包含以下请求头：

- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]

FAX.PLUS-Authenticate-3.png

完成后，您将收到一个包含访问令牌的响应，该访问令牌有效期为 1 小时，同时还会收到一个有效期不限的刷新令牌。

注意：如果您的 Fax.Plus 账户已启用 Advanced Security Controls，则刷新令牌根据安全规定的有效期为 30 天。这意味着您需要每 30 天重复一次此流程以获取新的刷新令牌。

第三步：获取新的访问令牌

当您的访问令牌过期后，您可以通过向以下 URL 发送 HTTP POST 请求，使用刷新令牌获取新的访问令牌：https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token]。

此过程需要包含以下请求头：

- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]

FAX.PLUS-Authenticate-4.png

获取访问令牌后，后续所有 API 调用都需要包含以下请求头：

- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]

第一步：设置初始身份验证流程

第二步：发送 HTTP POST 请求

第三步：获取新的访问令牌

Need Support?