24 Nov
2014
24 Nov
'14
4:26 a.m.
Hi Tom,
The version in the URL will not change except on a major change to the structure of the
API, e.g. if we ever go from the current RESTful API returning json encoded data to
something completely different. In which case the old API will remain under ‘/api/v1/‘ for
a period of time to allow scripts to be updated etc and the new version would be accessed
as ‘/api/v2’.
If you want to track changes you can use these two methods:
GET version
GET changeLog
The first will return the current version of the API (1.03 at the time of writing this
email). So you could use this to trigger an alert to the author of the client software
that something has changed.
The second will send you a complete history of versions and what changed.
If anyone has any requests for new methods for the API, please let me know.
Thanks,
Chris
I will add
another field “maskLength” then remove the “netmask” after a few days to allow any scripts
already written to adjust.
Please make sure to bump the API version number any time you remove or
dramatically change something. This will keep existing scripts from
breaking. (And I think you knew this when you designed it with a
version number.)