How can I setup the initial authentication flow?

In order to be able to use the FAX.PLUS API with your account, you need to authorize the API to access your account, then log in after authorization.

‍

How can I authorize the API to access my account?

To setup the initial authentication flow:

1. Go to the Profile section and click on the Integrations tab.
2. Click on the Activate button under the FAX.PLUS API section and collect the following data:

• Client ID (starts with APIK-)
• Client secret
• Redirect URI (one of them)

‍

3. Open the following link on a web browser to be redirected to a prompt to authorize the API to access your account: <span class="code">https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all</span>

‍

4. Once allowed, you will be redirected to the URL you mentioned with the authorization code as a URL parameter:

‍

How can I send an HTTP POST request?

Once you have authorized the access, you can now do a HTTP POST to: <span class="code">https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI]</span>

with the following headers:

• Content-Type: <span class="code">application/x-www-form-urlencoded</span>
• Authorization: <span class="code">Basic [base64-encoded string of "client_id:client_secret"]</span>

Once this is done, you will receive as a response the access token, valid for 1 hour, and the refresh token, valid forever.

<span class="info">If "Advanced Security Control" is activated for your FAX.PLUS account, the refresh token is only valid 30 days due to security requirements. It means you need to re-do the flow every 30 days to get a new refresh token.</span>

‍

How can I get a new access token?

When the access token is expired, you can get a new one using your refresh token, via a HTTP POST to: <span class="code">https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token]</span>

with the following headers:

• Content-Type: <span class="code">application/x-www-form-urlencoded</span>
• Authorization: <code class="code">Basic [base64-encoded string of "client_id:client_secret"]</code>

‍

Once the access token is retrieved, all API calls after that will need the following headers:

• Authorization: <span class="code">Bearer [access token]</span>
• x-fax-clientid: <span class="code">[client ID]</span>