要使用Fax.Plus API,您必须首先授予API授权才能访问您的帐户。 完成授权后,您可以登录到您的帐户。
验证有两种不同的方法:
- 生成和使用个人访问令牌。
- 使用 OAuth 2.0 流程。
个人访问令牌 可以作为身份验证方法安全访问 Fax.Plus API。 This token serves as a digital signature, allowing you to make authorized requests to our API, enabling actions such as sending faxes and retrieving data to your faxes.
Follow these steps to generate a new Personal Access Token:
- 登录到您的 Fax.Plus 帐户,然后去 Profile在您的仪表板上。
- Find the tab for Integrations.
- 在 Fax.Plus API之下,找到 个人访问令牌并点击 管理 的项目。
- Click on Generate Token and specify the token name, expiration date, and scopes (both edit and read as scopes on the token).
- Make sure to Copy your Personal Access Token now, otherwise you won't be able to see it again.
第 1 步:设置初始身份验证流程
- 登录到您的 Fax.Plus 帐户,然后去 Profile在您的仪表板上。
- Find the tab for Integrations.
- 在 Fax.Plus API之下,点击 激活并收集以下数据:
- 客户端 ID (以 APIK开始)
- 客户端密钥
- 重定向 URI (其中之一)
- 要启动授权API访问您的帐户的过程,只需点击此步骤上提供的链接即可使用 web 浏览器。 此链接将重定向到您可以授予必要权限的提示: https://accounts.fax。 lus/登录?response_type=code&client_id=[client ID]&redirect_uri=[重定向 URI]&scope=all
-
一旦授予权限,您将会被引导到您指定的URL,并附上授权码作为URL参数:
步骤 2: 发送 HTTP POST 请求
After you have successfully authorized access, you can proceed to perform an HTTP POST to the following URL: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Make sure to include the following headers in your request:
-
- Content-Type: application/x-www-form-urlencoded
- 授权: 基本[base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
完成后,您将收到包含访问令牌的回复, 有效期为1小时,以及无限期的刷新令牌。
备注: 如果您的传真。 lus 账户已激活高级安全控制,刷新令牌根据安全条例仍然有效30天。 这意味着您需要每隔30天重复进程才能获得一个新的刷新令牌。
第 3 步:获取新的访问令牌
Once your access token has expired, you can obtain a fresh one using your refresh token through an HTTP POST request to the following URL: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
This process requires the inclusion of the following headers:
-
- Content-Type: application/x-www-form-urlencoded
- 授权: 基本[base64-encoded string of "client_id:client_secret"]
获取访问令牌后,所有其后的 API 调用将需要以下头:
-
- Authorization: Bearer [access token]
- x-传真客户端: [客户端 ID]