The RTI (Remote Tracking Interface) allows you to use YellowFox functions via HTTP in third party software.
Requirements
- the RTI function must be activated for your company by YellowFox indoor service. After a succesful activation you will find in the "Extras" menu the "RTI (interface)" option.
- For every car or group you want to use with the RTI must be get a authorization code. The combination of the object and the company key denied the unauthorized access of one of your vehicles.
Introduction YellowFox Remote Tracking Interface
With the YellowFox Remote Tracking Interface (RTI) has among others following portal functions:
- track a vehicle or group once
- set automatic trace every X KM
- set automatic trace every X Min
- activate the motion detector
- get the last poistion of a vehicle or a group
- Show the last position on map
- send orders to vehicles
- receive order states from vehicles
- send/ receive messages
- set up vehicles for Order Management/Message Management
- address import via YellowFox Geocoder
The description for available functions and their usage can be found via this link.
Generate the authorization keys
- Go to the RTI (Extras --> RTI(interface))
- Generate the key for the company.
- Just select the "Create RTI key" action.
- The new 32 char key will be shown directly
- Generate now the keys for you vehicles and groups you want to use for RTI.
- For a single vehicle or group just use the action "Create RTI key" similar to get the company key.
- To generate the keys for multiple (or all) vehicles or groups first check the desired vehicles or groups and then use the upper left icon to "create RTI keys for selected elements"
- after a short waiting dialog the keys will be shown directly
To reject access to a vehicle or group either use the action "Delete RTI key" or again check the desired vehicles or groups and use the icon "delete RTI keys for selected elements" on top of the page
At every time you are able to generate new keys or to delete them. Please note, that if a new key was generated, the old one will be invalid.
The Remote Tracking Interface setup finished and you can use this function.
For each vehicle and group with a key there is an additional action "RTI links". Select this action will show a dialog with some example links to see how to use the rti functions with according return values.
Please note, if you want to use a group, all belonging vehicles must have a vehicle key. The allocation of a group key is not enough!
Settings
networkt access profiles
In order to limit access to the RTI interface to trustworthy network addresses (e.g. company network), there is the option of creating and managing profiles that describe certain network addresses or areas.
These profiles can then be assigned to the company. When a request is made via the RTI, the first thing that is checked is whether the request comes from an IP address that is permitted via one of the assigned profiles.
Otherwise the request will be rejected with an error message.