Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

We know that many of you prefer to utilise our current API, and therefore as our products grow we need to frequently review our exisiting tools to ensure they are delivering the most value to our users. In support of this we have introduced our API v2, which has been written in JSON rather than XML. , and meet our future needs.

The current API has become outdated and we needed to freshen things up to help move it forward with new functions and improved technologies. InfoSee our SwaggerHub account for technical information on our new API v2In support of this we have introduced our API v2, which has been written in JSON rather than XML.

Our Approach

We know that many of our partners make use of the current API, therefore we are not planning to remove this until the end of 2021, and rather we are introducing the new API v2 to work in parallel alongside the current one – this means NO immediate changes are needed by our partners.  The new API v2 is already available as a BETA release, which is included in the December 2020 version of the dashboard.

...

·        Connection User Links

·        Hierarchies 

We will be introducing new functions into the API v2 in 2021, around User Layouts and Connection user links to give you a flavour.  A timeline for these will be shared in early 2021.

Info

See our SwaggerHub account for technical information on our new API v2

Key Partner Takeaways

  1. Our API is changing, but you don’t have to move to the new v2 just yet… we’re keeping the old one as it is in place for 12 months

  2. The new API v2 will be a like for like in terms of functions – but written in JSON rather than XML

  3. We will be introducing new functions into v2 further down the line, and we’d like to hear from you about things you’d like to see included

Still Want More?

As you will appreciate, we are still in BETA mode with the new API v2, therefore to help provide complete documentation of the features we have introduced a SwaggerHub account to help inform you of what you can expect from the new API.

...

Considering Migrating To API v2?

To make the new API v2 easier to migrate to, we suggest that you use a wrapper to call the API.  Here is an example of making a call within a wrapper.

...