SolarFarmer API Versions
We support two concurrent versions of the API, to help give you a bit of time to accommodate any new changes when we make new releases.
Here's how it works:
- The API URL https://solarfarmer.dnv.com/latest/api/ will ALWAYS point to the latest version.
This is the preferred URL to use if you're happy to be always using the latest version.
Using this means that you understand that it will contain the latest version and that the calculation code called with this URL will change with each release. - The API URL https://solarfarmer.dnv.com/api/ will also continue to point to the latest version for the time being, but may eventually be deprecated.
- At each release we will also release a versioned URL for the new version.
- The previous version will still be available via its versioned URL.
- Any other previous releases (via their versioned URLs) will not be supported and return the 410 (Gone) http status code.
- We will continue with our (approximate) 3-monthly release cycle.
To illustrate this process:
Available versions - latest release (7 September 2023)
| Version | API URL | API build number | Release date |
|---|---|---|---|
| v1 | https://solarfarmer.dnv.com/v1/api/ | 0.2.254 | 11 April 2023 |
| v2 | https://solarfarmer.dnv.com/v2/api/ | 2.0.2 | 7 September 2023 |
| v2 | https://solarfarmer.dnv.com/latest/api/ | 2.0.2 | 7 September 2023 |
| v2 | https://solarfarmer.dnv.com/api/ | 2.0.2 | 7 September 2023 |
Available versions - proposed next release (approx December 2023)
| Version | API URL | API build number | Release date |
|---|---|---|---|
| v2 | https://solarfarmer.dnv.com/v2/api/ | 2.0.2 | 7 September 2023 |
| v3 | https://solarfarmer.dnv.com/v3/api/ | 3.0.0 | December 2023 |
| v3 | https://solarfarmer.dnv.com/latest/api/ | 3.0.0 | December 2023 |
| v3 | https://solarfarmer.dnv.com/api/ | 3.0.0 | December 2023 |
You can just keep pointing to the standard API URL (https://solarfarmer.dnv.com/latest/api/) and you will get the latest release.
If there are breaking changes with this release, you can quickly use the previous version (using the versioned URL) whilst you update your scripts/code.
SolarFarmer API Website
The website to get your API web token (https://solarfarmer.dnv.com) is the same. There isn't a different website for each version.
The Docs tab of the website (https://solarfarmer.dnv.com/docs) where you can try out the different endpoints and see the Swagger documentation for the classes used with the endpoints has a drop-down to choose the appropriate version number.