Changelog
Serving V2 by default1st February 2012
On February 1st 2012 we introduced the V2 API as the default version for all requests. If you do not provide a version parameter in your requests, V2 will be used.
What's changed?
Request parameter & response property names have been standardised. In particular, the
username/user_nameandjournal_nameparameters are now titleddisplay_nameandjournal_titlerespectively across all resources.The
nohttperrorparameter has been deprecated. This means that, from V2 onwards, all responses headers will contain a200 OKstatus code, regardless of any underlying API error code.For JSON & PHP responses, the
errorproperty containsnullwhen the request was successful. Previously this property pointed to an empty object, which was inconsistent with the behaviour of the other properties.All responses include a
versionproperty, containing the version number used to process the request.
Has this broken my existing app?
Unless we created an exception for your app, requests without a version parameter may now behave differently. We strongly suggest you specify a version number, or contact us about an exception.
When will version 1 be turned off?
We currently have no plans to disable version 1, however new features & resources will only be available on version 2.
How do I see what's different in each resource?
Check the documentation for each resource you currently use. Documentation for each resource is now split into tabs for each version.