Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen

The RTI (Remote Tracking Interface) allows you to use YellowFox functions via HTTP in third party software.

Panel
titleIndex

Table of Contents
maxLevel3
indent20px

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

  1. Go to the RTI (Extras --> RTI(interface))
  2. Generate the key for the company. 
    1. Just
    click in "create" on the ride hand side of your company name. A 32 long digit
    1. select the "Create RTI key" action.
    2. The new 32 char key will be shown
    .
    1. directly
  3. Generate now the keys for you vehicles and groups you want to use for RTI. Either you click on "create" once for every vehicle and group or you click on "create all" to generate for all existing vehicles/ groupes. If you want to delete the key, just click on "delete" respectivly "delete all". 
    1. For a single vehicle or group just use the action "Create RTI key" similar to get the company key.
    2. 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"
    3. after a short waiting dialog the keys will be shown directly
  4. 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!

Further Informations

Technical documentation