This tutorial shows how to generate, reveal or reset an account’s API key from the etherFAX Client Portal.


Info, Notes and Warnings

Depending on the privilege of the portal user and the account configuration, this feature may not be available.


Prerequisites

Before reading these instructions be sure that the following prerequisites are met:

  • An account with portal access the ability to generate an API key.

  • A portal user with privileges to show or generate the API key.


Instructions

How to generate or show the account API key

  1. Sign into the Client portal at https://clients.connect.etherfax.net.

  2. Click on Settings and then Account:

  3. Under Account Information, you will see the option to Generate API Key or Show API Key.

  4. Click Generate API Key should you wish to use an etherFAX API key to integrate with a fax solution:

  5. If the goal was to see and copy the API key then click Show API Key and then click the Copy button:

  6. If the goal is to reset the API key then click the Reset API Key button:

You have now successfully generated, revealed or reset the API key!


Ending Notes and Details

Resetting an API key can cause authentication failures in your fax solution’s environment. This can prevent outbound and inbound faxing altogether.

Not all configurations require use of an API key. For example, an account using DirectFax products or Lexmark devices exclusively would likely have no need to generate or use an API key.