Acquiring your web API token
To acquire your API token:
Visit the SolarFarmer Web Service website https://solarfarmer.dnv.com
Log in using your Veracity credentials
You must have a Veracity account (https://www.veracity.com/ - DNV's cloud platform) to use the system, and be registered on the SolarFarmer web service.
Create a Veracity account (it's free!) if you do not have one, making sure to add your mobile phone number to the account.
If, when logging in with your Veracity account, you find you are not registered with the SolarFarmer web service and you believe you should be, please email firstname.lastname@example.org and we can add you.
We use Multi-Factor Authentication (MFA) when logging into the web service website for added security.
This means it will ask to send you a code via SMS or phone to authenticate you, using the number you registered with your Veracity account. Once you have done this, it shouldn't ask you again for 8 hours unless you log out.
Copy the API token to your PC's clipboard (press the blue 'Copy API token to clipboard' button):
If your clipboard is empty after you press the Copy button, try logging out, closing the browser, opening the website, logging in again and refreshing (CTRL-F5). Especially if you have just been added to the web service. The browser can cache older data, so this is a way to refresh it.
To use your API token:
- See Running calculations in the cloud from SolarFarmer for how use your API token with the SolarFarmer desktop application.
- See SolarFarmer's Web API for the starting point on how to use your API token from your own scripts
Your API access token is a secret. Treat it like your password. Never share it with anyone.
If you believe your token has been compromised, let SolarFarmer support know (email@example.com) and regenerate your token on the web service website. This will immediately make any previous tokens unusable.
Email firstname.lastname@example.org if you have problems getting your API token.
API token expiry and regeneration
Your API token will expire after 1 year. This is a fixed time-span. There will be a warning on the home page from 30 days before it expires.
Once it expires it can no longer be used to access the API (it will return an Unauthorized error) and you will need to regenerate it to continue using the API.
Please regenerate your own token by pressing the blue 'Regenerate API token...' button on the home screen of the website. You can regenerate your token as often as you like, when you like; but only the latest token will be valid:
As soon as you regenerate your token any previous tokens will be rendered invalid and won't work.
So plan ahead and replace any old tokens in your scripts/systems with the regenerated new one.