TrackerPro Admin API: Overview This section provides an overview of how data flows to and from the TrackerPro Admin API. As the API is JSON based, make sure you’re familiar with http and JSON. All calls to the TrackerPro Admin API should be made to: https://trackerpro.payasyoutrack.com/trackerpro_Admin.ashx Request Calls should be made using either a http ‘GET’ or ‘POST’ request. ‘GET’ requests are permitted mainly for testing purposes. These can sometimes fail if the query string is too long so where […]

TrackerPro Admin API: Data Concepts Type 2 responses (ones with dataset) are returned from the TrackerPro Admin API in a format that is based on (but does not fully follow) the Google Visualization JSON format. This is described here: https://developers.google.com/chart/interactive/docs/dev/implementing_data_source#json-response-format A typical successful call to the TrackerPro Admin API will result in a status of “ok” and a “dataset” field. This is where the payload of the TrackerPro Admin API deviates a little from a Google DataSource. A Google DataSource […]

TrackerPro Admin API: Creating PAYT Clients & Users The TrackerPro Admin API contains a Register endpoint to allow the creation of PAYT clients (and users). A PAYT client is a top level PAYT entity. All users and tracking data are stored against a client with PAYT. Registering a PAYT Client If not already created, this call creates a new client within the PAYT system. Also, if not already created, it creates a new user ssid for the user. Make this […]

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 […]

TrackerPro Admin API: Embedding View Recall that PAYT View can be embedded into a webpage as an iFrame by setting the appropriate src in the iFrame. <iframe id="paytframe" width="100%" height="500" src="https://trackerproview.payasyoutrack.com/#Embed/LiveMapView/{XXXXLAUNCHTOKENXXXX}" frameborder="0"></iframe> Different initial views can be launched by using a different URL. Here are some examples. Live Map View – https://trackerproview.payasyoutrack.com/#Embed/LiveMapView/{XXXXLAUNCHTOKENXXXX} Reports View – https://trackerproview.payasyoutrack.com/#Embed/ReportsView/{XXXXLAUNCHTOKENXXXX} Assets View – https://trackerproview.payasyoutrack.com/#Embed/AssetsView/{XXXXLAUNCHTOKENXXXX} Dashboard View – https://trackerproview.payasyoutrack.com/#Embed/DashboardView/{XXXXLAUNCHTOKENXXXX} Places View – https://trackerproview.payasyoutrack.com/#Embed/PlacesView/{XXXXLAUNCHTOKENXXXX} Controlling the iFrame It is possible to send and receive messages from […]

TrackerPro API Welcome to the TrackerPro API documentation. If you don’t find what you are looking for, please get in touch! Server API Getting Started How does the API work? Overview | Data Concepts | Json Dates Launching PAYT Launch ‘portal’ or ‘view Overview | Launch Portal | Launch View Tasks Adding & Editing Tasks Overview | GetTasksByDate | Update   Registering Clients/Users Registering new PAYT clients & users Overview Embedding PAYT Embedding PAYT View in a website Overview Vehicles […]

TrackerPro Admin API: Task Task information is sent to and from the API in a TasksDataSet table. Calls in this section GetTasksByDate Bulk retrieve tasks for a client by date range. Request (Query Parameters) Parameter Value Notes op Task Required subop GetTasksByDate Required company Client/Account name Required fromDate {number millisecs since 1970-01-01} Required toDate {number millisecs since 1970-01-01} Required dtm Datetime format for returned data. By default will return dates as millisecs since 1970-01-01. Set to ‘o’ if you want […]

TrackerPro Admin API: Vehicles Vehicle information is generally returned from the API in a VehicleDetailsDataSet Asset table. To reduce the number of server calls this is an unnormalised view of the current state of the vehicle. It includes information such as the currently assigned driver and tracker as well as some standard vehicle fields. Note that the unique VehicleId field is important as a number of other calls in the system require this as a parameter. Calls in this section […]

TrackerPro Client API After you have embedded PAYT View into your own webpage, you may control the component using Javascript messages. The following sections assume you have embedded the component correctly using code similar to the following: <iframe id="paytframe" width="100%" height="500" src="https://trackerproview.payasyoutrack.com/#Embed/LiveMapView/{XXXXLAUNCHTOKENXXXX}" frameborder="0"></iframe> Step 1: Reference the iFrame Within javascript on your page obtain a reference to the iFrame var mapFrame = document.getElementById('paytframe');const if_doc = mapFrame.contentWindow; Step 2: Sending Commands TO the iFrame Messages can be sent to the iFrame […]

TrackerPro Client API: LiveMapView PAYT View can be embedded into a webpage as an iFrame by setting the appropriate src in the iFrame. To launch LiveMapView the iFrame should look something like this. <iframe id="paytframe" width="100%" height="500" src="https://trackerproview.payasyoutrack.com/#Embed/LiveMapView/{XXXXLAUNCHTOKENXXXX}" frameborder="0"></iframe> Commands associated with the embedded ‘LiveMapView’. Demonstration here Action Parameters Example Comments clusterOn boolean {“action”:”clusterOn”,”params”:false} Toggle clustering on/off filter string {“action”:”filter”,”params”:”RF23″} Add a filter to the map. For example, focus on a single vehicle keepOnMap boolean {“action”:”keepOnMap”,”params”:true} Keeps the currently selected […]