The API Authentication is implemented as HTTP Basic Authentication over TLS (HTTPS). Your API login credentials are not the same as the credentials you use to log in to the web interface. You must obtain your API credentials separately.

Obtaining Your API Credentials

Your API key can be accessed from the “Partner” page.

Your http username is your “API Key”.

Your “password” does not matter.

Authenticating with your API Credentials

You will use HTTP Basic Authentication to verify your identity via the API. All requests must come over TLS/HTTPS. For example, if you wanted to access a Company resource:

https://cleverfoxbackup.com/api/companies

Please review the recommendations for setting your HTTP Accept and Content-Type headers as outlined in the API Introduction.

Troubleshooting

If you are unable to connect, the problem is often that you are using an old/unsupported version of SSL or TLS. In this case, CleverFox Backup will simply drop the connection, and the error message you receive may be cryptic.