RTI - Interface
Table of Contents
The RTI (Remote Tracking Interface) allows you to use YellowFox functions and access its data via HTTP in third party software. You can find the technical documentation here.
Introduction
The RTI interface offers the possibility to access data from YellowFox and import it into another system. You might also import new data to Yellowfox. You might for example:
- access position data
- change vehicle settings
- get form or order data
- send new orders or messages
- upload files
- manage time bookings
- import addresses
The interface offers much more functions, which you can read about at the technical documentation. If you are interested to import Tours to YellowFox or to access tour data, you might take a look at the separate Tour Webservice.
Requirements and Setup
The RTI interface must be activated by our in-house staff. Feel free to contact us. After the module has been unlocked, you can access its settings via the mainmenu → Administration → Administration → RTI Interface.
To use the interface you have to generate RTI keys first.
What is a RTI key?
The RTI interface uses a 2-step-authentification. This means you always have to pass 2 keys to avoid unauthorized access. These keys are generated at the portal. A key is a random hexadecimal code. RTI keys are sensitive information and should only be shared if needed. Only by using these keys you can get data via the interface. YellowFox distinguishes 4 types of keys:
- company key: This key identifies your company and is needed for any request.
- vehicle key: This key identifies a single vehicle. It is needed for accessing vehicle data, like e.g. position data.
- group key: This key identifies a vehicle group. By using a vehicle key you might e.g. get position data of all vehicles which are part of this group. Attention: Only data of vehicles which own a vehicle key will be returned!
- import key: This key is an universal key. It is used to access all cars or personnel data.
Create RTI keys
RTI keys are generated via the portal. Go to RTI Interface settings. At global keys you can generate the company and import key. If you already generated a key, you might also change or delete it. A change would lead to the key being generated again. This might be helpful if you unintentionally shared a key with someone who wasn't supposed to see it. If you remove a key, all functions which use it are not accessible anymore.
Via vehicle keys you can generate a key for each vehicle. Vehicles might be deactivated without having to remove the key. For example you could activate a key for a partner while the vehicle is working on a specific tour and after the tour is finished, you can lock the vehicle again. Vehicles can not only be identified by a key, but also by a so called RTI ident. While the key is generated automatically, you can set the ident by yourself. This might be helpful to manage keys easier in another program. Idents can only be used if you combine them with a valid group key. You can find the instructions to use RTI idents at the technical documentation. You can use the action menu to get some example calls via RTI Links.
Via vehicle group keys you can generate the keys for vehicle groups. Here you can also see the assignments of vehicles to each group and if the vehicles even have a key or are currently locked. Vehicles without vehicle keys are not considered in group requests even if they are assigned to the group.
Paid RTI Functions
In addition to network access profiles, you can also manage specific function approvals within the RTI interface settings.
Where to find the settings
In the portal, navigate via the Main Menu → Settings (gear icon)
→ Administration → RTI Interface.
There, switch to the Settings tab (wrench icon)
on the far right. In the left menu, select the Permissions option.
Enabling paid RTI functions
The use of certain RTI functions incurs additional costs, as they can activate paid add-on features. To avoid unwanted costs, these functions must be explicitly enabled:
- To enable: Check the box next to "Enable paid RTI functions" and confirm your changes by clicking Save.
- Disabled status: If this option is not active, the affected functions will simply return an error code when used.
Which functions are affected?
Currently, the following function from the RTI interface is affected by this approval:
- Personnel Management:
- Allows enabling and disabling the driver's license check for a person in the system.
For more information, please contact our support team.
Full documentation
Network assign profiles
If you created network assign profiles for your company, these do also influence RTI requests. You can assign them to your company at the settings. Request from an unknown network will be quit automatically.