Implementation notes

Communication Modes

All communication must take place on a server-side (as opposed to client-side) basis, so that the API is not publicly exposed and your authentication token remains unique.


While not explicitly required, where possible, we ask that you cache server responses to prevent sudden spikes in repetitive traffic, whilst reducing network overhead and optimising the experiences for your users. Each endpoint has cache notes for implementation.


We use versioning as a way of introducing new functionality and changes to the API without breaking your current integration. Because of non-breaking changes and bug fixes, your server side should be able to handle additional properties in the response gracefully.


(Hypermedia as the Engine of Application State) is a feature of the REST application architecture, it provides information to navigate other REST interfaces dynamically by including hypermedia links with the responses.