ITAS API v2 & v3

Overview

V2 enabled Hivedome to start to define a model from scratch that will more accurately reflect the ITAS system as a whole. As a rule there is relationship between a single endpoint and a particular ITAS database table (e.g. http://itas.apiary.io/ReferenceData/TradingEntityId/ClientLedger/ClientAccounts/ClientAccountId exposes data from the xx_chr20 table), but this cannot be taken verbatim as the APIs also include business logic which may or may not read or update data in other tables as well.

ITAS API v2 provides a mixture of reference data and ITAS process endpoints that utilise business logic in both VB6 DLLs and our C# BLL (business logic layer). Over time we plan to replace v2 with ITAS API v3 and eventually migrate all existing v2 users to the new version.

The introduction of ITAS API v3 will improve the performance, flexibility and maintainability of the ITAS API by consolidating all business logic into the C# codebase.

The process of replacing ITAS API v2 has already begun with a C# only version of the FinanceCash endpoints having been recently added to ITAS API v3 and will continue with further endpoints over time.

The switch from v2 to v3 should be low risk and should have the minimum impact to your existing integrations as ITAS API v3 also includes all v2 endpoints, ensuring backward compatibility.

Any further transitions of code will be assessed, with the plan being communicated to clients before any development work is carried out. Both versions will remain available for the foreseeable future to allow clients plenty of time to plan and test before finalising their transition.