/
API

API

Our API

The latest API is known as v2, and was introduced as part of our December 2020 software release.

How Does The v2 API compare to v1?

The v2 API is based on a JSON file format, rather than XML as per the v1 API. The v2 API delivers like-for-like functionality that was found in v1, and has since been expanding upon.

The key functions most commonly used include;

·        Authentication

·        User creation, updating and deletion

·        Category creation, updating and deletion

·        Role creation, updating and deletion  

·        Retrieving a list of Charts

As part of the upgrade to v2, we took the opportunity to remove some redundant functions from the v1 API, meaning v2 is leaner and remains relevant. The following functions were removed:

·        Preferred Layouts

·        Connection User Links

·        Hierarchies

 

Additional Resources

Please refer to the following resources for more information on how you can configure and utilize the v2 API;