UniTiAg APIs

UniTiAg provides the TSMP API for interactions with Two-Sided Marketplaces (TSMPs), along with the TA and TANB APIs for communication with Transit Agencies. Let’s discuss them further.

API Documents Copyrights

By downloading the API documentation presented on this page, you agree that these documents are the intellectual property (IP) of Lifecycle Integrity Inc., Ontario, Canada, with author rights belonging to Eugene Lishak. You are prohibited from publishing, distributing, or using these documents for purposes other than integrating your systems with UniTiAg without explicit permission from the IP owners.

TSMP API

TSMPs use this API to interact with UniTiAg for managing Riders’ OTRBs and retrieving reconciliation data from Transit Agencies (TAs). However, the reconciliation process itself falls outside the scope of the API, as it must be conducted between the TSMP and the TAs based on the TSMP’s policies and its agreements with the TAs as merchants or sellers.

 

You can download TSMP API User Guide document here: TSMP API User Guide v1 – document rel 2.

TA and TANB APIs

UniTiAg supports two Transit Agency APIs: TA API and TANB API (Transit Agency Near-By API).

  • TA API is hosted by the Central UniTiAg Host. It facilitates calls that do not require low latencies but necessitate centralized sharing of OTRB data across multiple TAs. It enables the TA ABT System to post recent fares and discounts, and requests ticketing reports.
  • TANB API is supported by Regional UniTiAg Hosts located in specific geographical regions where TAs operate. These hosts maintain targeted replicas of TA-specific OTRB data for each TA in this region. This reduces latency for TANB API calls by ensuring faster access within the region.

A UniTiAg Regional Host includes an OTRB in its targeted replica after the associated card is first tapped at a TA within that geographical region, activating the TA on the OTRB. Alternatively, a Rider can manually activate a TA if planning future use. Having the OTRB in the regional targeted replica enables faster TANB API access. Latency is influenced by geographical distance, with signal propagation in fiber optics being ~5 ms per 1000 km. Real-world latency, considering DNS resolution and handshaking, is typically 15-20 ms per 1000 km or more, depending on the network infrastructure.

The first card tap at a non-active TA may experience a delay due to the Central UniTiAg Host being geographically distant. Subsequent taps are handled by the nearest Regional UniTiAg Host via the TANB API, reducing latency. If TANB latency remains high, the TA ABT System can periodically sync active OTRB data to its local memory using the Sync OTRBs TANB API call. Wireless Validators, particularly those on moving vehicles, can also use this call to store OTRB data locally, ensuring continuity when wireless connectivity is unreliable.

Each Regional UniTiAg Host maintains targeted OTRB replicas, separately for each TA in this region. This structure helps further reduce the latency of OTRB data retrieval through the TANB API.

Validators can also communicate with the TA ABT System through the TA’s proprietary APIs, which are not depicted in this diagram and are not supported by UniTiAg.

You can download TA /TANB API User Guide document here: TA APIs User Guide v1 – document rel 2.

API User Guide Appendices

UniTiAg API User Guides are better understood if they are read together with the attached UniTiAg User Guide Appendices document: UniTiAg User Guide Appendices v1 – document rel 2

Attachments