TrackerPro Admin API: Creating PAYT Clients & Users
September 13, 2024
TrackerPro Admin API: Embedding View
September 23, 2024
TrackerPro Admin API: Creating PAYT Clients & Users
September 13, 2024
TrackerPro Admin API: Embedding View
September 23, 2024

TrackerPro Admin API: Launching PAYT

After a user has been registered with PAYT it is possible to obtain a launch token using the TrackerPro Admin API. This launch code can be used to launch either the legacy PAYT interface (portal), the newer PAYT interface (view) or embed a ‘non frills’ version of PAYT as an IFRAME in your website.

Obtain Launch Token

After a user has been registered with PAYT and an ssid generated (XXXXUSERSSIDXXXX) the ‘Launch’ call can be used to generate a single use authorisation token. This (single use) token can then be used to launch one of the PAYT interfaces as described above.

Example Request

https://trackerpro.payasyoutrack.com/trackerpro_admin.ashx?key=XXXXADMINKEYXXXX&op=Admin&subop=Launch&ssid=XXXXUSERSSIDXXXX
Request (Query Parameters)
Parameter Value Notes
key {XXXXADMINKEYXXXX} Required – TrackerPro admin api key
op Admin Required
subop Launch Required
ssid {XXXXUSERSSIDXXXX} Required – the ssid returned when a user is registered with PAYT

Example Success Response

{"version":"0.6","reqId":"0","status":"ok","sig":"","value":"488A6802-AD46-4BB4-B2E3-653C3ACF9F14"}

The returned ‘value’ is the launch token ({XXXXLAUNCHTOKENXXXX} in the documentation) for this user. This launch token can now be used to open the portal, or view or embed view within an iframe. This token will timeout after portal/view is closed and should be regenerated each time the user wishes to launch one of these interfaces.

Example Fail Response

{"version":"0.6","status":"error","errors":[{"reason":"invalid_query","message":"User name should be unique to client"}]}

 

Launch Portal

Launch ‘portal’ by opening the following link. {XXXXLAUNCHTOKENXXXX} should be replaced by the launch token.

https://trackerpro.payasyoutrack.com/?authtoken={XXXXLAUNCHTOKENXXXX}

Launch View

Launch the ‘view’ by opening the following link. {XXXXLAUNCHTOKENXXXX} should be replaced by the launch token.

https://trackerproview.payasyoutrack.com/#Launch/LiveMapView/{XXXXLAUNCHTOKENXXXX} 

 

Embedding View

Embed ‘view’ in an iFrame by setting the appropriate src in the iFrame. {XXXXLAUNCHTOKENXXXX} should be replaced by the launch token.

<iframe id="paytframe" width="100%" height="500" src="https://trackerproview.payasyoutrack.com/#Embed/LiveMapView/{XXXXLAUNCHTOKENXXXX}" frameborder="0"></iframe>  

Please see Embedding View section for more information about how to embed view in your webpages.

Back to: Contents


 

 

PAYT Icon for Apple Store