Getting Started with iClient (Browser-Based)

The main steps for getting started with development for Tyro iClient are as given below:

1. Checking for Prerequisites.
2. Including the iClient JavaScript library.
3. Pairing to the integration server simulator.
4. Registering your Point-of-Sales software.

When completing step 4, please refer to the specific criteria pertaining to the POS Information fields and the API key configuration.

iClient API

Please refer to the Please refer to the iClient API for a sample HealthPoint claiming code. After downloading the zip folder, unzip it and click on the iclient-api folder, and then index. At the top left corner underneath the APIs, click on Classes, and then click on TYRO.IClientWithUI, scroll down until you see the index and method tabs, then click on index.

Checking for Prerequisites

Before getting started, please ensure that following prerequisites are met:

• Please use a compatible browser for your development.
• Please note that Tyro iClient is only compatible with the following browsers:
  • Google Chrome.
  • Mozilla Firefox.
  • Safari.
  • Microsoft Internet Explorer.
  • Microsoft Edge.
• Additionally, when using the integration server simulator, you will also need your allocated Merchant ID (MID) and Terminal ID (TID) combination to pair with the integration server simulator. Please reach out to the POS Integration team via email and they will provide the allocated pairing credentials.

Including the iClient JavaScript library

The following steps can be followed:

• Headful iClient

<script type="text/javascript" src="{Base URL}/iclient-with-ui-v1.js"></script>

• Headless iClient

<script type="text/javascript" src="{Base URL}/iclient-v1.js"></script>

If you are developing features that require testing using both the simulator and the development terminal, please develop a mechanism that allows the base URL and the environment to be easily switched between the integration server simulator and the development terminal.

Pairing to the integration server simulator

The pairing process uses a merchant ID and terminal ID combination. This will be provided to you by the Tyro POS integration team.

• The pairing request is initiated from an embedded pairing URL (as shown in the below image. This configuration page has to be embedded in an iframe in the POS.), this can be found here , once you start a pairing request it will need to be confirmed physically on the terminal, the pairing page will then get a response confirming the pairing.

• If the user clears local storage in the browser the pairing details will be deleted and the terminal will need to be re-paired.

Registering your Point-Of-Sale software

When using iClient, you must register your POS software using our POSInformation method ensuring that the correct and relevant information pertaining to your POS integration is returned to the Tyro servers in the integration requests. This helps us identify integration requests and aides our support team in resolving any issues that may come up in production. The specification and example for Headful and Headless iClient is given below.

Headful iClient

Specification:

TYRO.IClientWithUI(apiKey, posProductData)

Parameters:

• apiKey (String) - The API key provided by Tyro. (not validated in test environments)
• posProductData - An object containing the following properties (final values to be confirmed by Tyro):

Example:

var iclient = new TYRO.IClientWithUI("apiKey", {posProductVendor: "Awesome POS CO", 
posProductName: "AwesomePOS", posProductVersion: "1.0.1"}); 

Headless iClient

Specification:

TYRO.IClient(apiKey, posProductData)

Parameters:

• apiKey (String)- The API key provided by Tyro (not validated in test environments).
• posProductData - An object containing the following properties (final values to be confirmed by Tyro):

Working Example

Below is a JSFiddle example that demonstrates the POS information being set in the method and then being retrieved from the iClient object and displayed when the “Show POS Information” button is clicked.

Demo - JS Fiddle