Skip to end of banner
Go to start of banner

API Migration guide

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 11 Next »


Introduction to V4

The migration documentation for each section will explain the differences in more detail so this is just a high level overview of "what's new".

V4 is an ongoing redesign of our API to make it more REST compliant.  More of the new endpoints will be rolled out as features and improvements are deployed.

You will notice that endpoints are focused on specific resources, and we limit the relationships that can be fetched. 

This reduces parameter variability and the amount of data that must be pulled from the database;  As a result the response should be quicker to generate and easier to cache.

You'll notice that the responses adhere to the JSON API 1.0 standard (http://jsonapi.org/) and wherever possible the recommendations have been accepted as well.

  • No labels