TomTom WEBFLEET - Support Home Page

TomTom WEBFLEET.connect
Release note Spring ‘11
TomTom Business Solutions would like to announce the forthcoming rollout of the WEBFLEET.connect
“Spring 2011” release. The production rollout is scheduled between next Monday (30th May 2011)
evening and next Wednesday (1st June 2011) morning. The updated reference manual accompanying
this release will be made publicly available on the web after the release rollout.
Key Additions and Improvements
The number one functional addition of the Spring 2011 WEBFLEET.connect release is support of TomTom
WEBLEET OptiDriveTM. TomTom WEBLEET OptiDriveTM is part of the WORKsmart-Safety solution suite.
WEBFLEET.connect supports retrieval of the OptiDriveTM indicator and trend as well as of several
indicator base items that are aggregated in the overall indicator value and trend. For details please refer
to the WEBFLEET.connect reference for showOptiDriveIndicator and for general information on
WEBFLEET OptiDriveTM to the Explore WORKsmart guide available on the TomTom Business Solutions
website. Fleet level configuration data relating to the OptiDriveTM indicator calculation are accessible in
showSettings.
The WEBFLEET.connect API has been completed with several functions for handling vehicle groups
(object groups). There is a full set of functionality now that allows to create, modify, and view vehicle
groups and to manage relationships between vehicles and vehicle groups (add to group, remove from
group).
The WEBFLEET.connect vehicle group API has seen a complete technical overhaul including renaming of
existing functions to the current naming convention while retaining full backward compatibility for
existing system integrations.
We introduce initial support for API Keys in WEBFLEET.connect. API Keys will allow new
WEBFLEET.connect system integrations to get up and running more quickly and with minimal
administrative work. API Keys will be issued to system integration partners on request. A
WEBFLEET.connect system integration partner who has procured an API Key will be able to “sign”
multiple instances of their integration software at different customer sites and running on different
WEBFLEET account’s fleets. The process for enabling each individual WEBFLEET account for
WEBFLEET.connect API access will become obsolete when API Keys are used.
With regards to the character encoding returned by the CSV API we harmonized all data query functions
to return UTF-8 encoded payload. The response payload character set and encoding is indicated by the
standard HTTP headers for this purpose. Having also the CSV API fully UTF-8 enabled will help customers
to fully leverage the improved language support for the latest TomTom Business Solutions PRO
generation devices.
Note on backward compatibility: As we are aware that changing the character set may need adaptations
on a few currently productively used WEBFLEET.connect integrations we have a fallback procedure in
place. The adapted data query functions can be reverted to returning ISO 8859-1 for a limited period of
time by request to TomTom Business Solutions customer support until the integration has been made
capable to use UTF-8 or to dynamically pick up the character set and encoding of the response and
handle the payload accordingly.
1
Detail Improvements and Fixes
The function showObjectReportExtern has seen detail improvements. In addition to the existing result
data it now returns the current odometer value, the current standstill state of the vehicle, the current
ignition state and the timestamp of the most recent ignition state change, the current trip mode, the
remaining distance to the current navigation destination, and information whether a PND is connected to
the LINK (for LINK classic, LINK3x0).
The function showVehicleReportExtern as of this release returns also the vehicle’s color, the speed
limit, and the descriptive text attached to the vehicle.
The deleteDriverExtern function as of this release deletes implicitly any TomTom Remote LINK ID Key
assignments which exist for the driver which is deleted. This frees up these ID Keys for use with another
driver.
The validation in sendDestinationOrderExtern has been relaxed. This function does not require address
details to be provided when sending out an order with an explicit destination specified in the request.
The data query showOrderReportExtern returns all data up to the future end of a convenience date
range designator when using the convenience date range designator w0 (current week), m0 (current
month). This means the data query can be used to retrieve not yet started / incomplete orders scheduled
for the future in addition to the historical view back in time. The showOrderReportExtern data query
will also return user input (as received from the TomTom device) that was supplied with order state
changes (e.g. the reason for cancelling order when the driver supplied this).
For data query showIdleExceptions there are two new optional query parameters: driver and driver
group. These will help to build driver centric views in an integration application using this data query.
Rebranding from TomTom WORK to TomTom
Business Solutions
We will reflect the rebranding from TomTom WORK to TomTom Business Solutions in the endpoint URLs
which are publicly available to access the CSV and SOAP APIs of WEBFLEET.connect.
The new endpoint URLs as documented in the reference manual from now on are:
•
CSV API - http(s)://csv.business.tomtom.com, plain HTTP still supported but discouraged due to
security reasons. If you undertake any work to change the endpoint URL of an existing
integration on the CSV API please also consider switching to HTTPS.
•
SOAP API - https://soap.business.tomtom.com
The current endpoint URLs http(s)://connect.webfleet.tomtomwork.com and
https://soap.connect.webfleet.tomtomwork.com will be kept operational for (at least) another two years
until end of Q2 2013.
Documentation Changes / Enhancements
The reference manual version for this release is 1.8. It will be available after the next web site update.
Please use only the latest manual version from then on. The Reference Manual covers all major and detail
additions to the API. We have added a section (Appendix C) that lists all currently superseded (but
technically still supported) functionality. This documentation section informs about the announcement
date, planned end of life date and available alternatives for functionalities that have become superseded.
2
We have slightly reordered the sections of the functional reference to make the WEBFLEET.connect
Message Queues Service Number 1 to outline its importance.
Retiring Old SOAP API Versions
TomTom Business Solutions is currently offering the SOAP API in 4 versions (1.0 through 1.4)
productively. We will retire the older versions beginning from May onwards. Any requests of existing
applications integrating on the SOAP endpoints which are going to be retired will be automatically
forwarded to the latest backward compatible SOAP API version. This means there is no need to change
existing integrations. However we encourage all users to change the applications for which there is
planned maintenance in the coming months to the latest endpoint (version 1.5).
The retirement planning is as follows:
•
SOAP API 1.1, 1.2 will be retired around mid-June 2011
•
SOAP API 1.0, 1.3 will be retired around begin of July 2011
Announcement of Past and Future Changes
We plan to apply general Web security rules (HTTP protocol compliance, reject typical attack signatures)
to the public production endpoints in Q2 or Q3 2011. This security measure is not expected to affect any
production customers as TomTom Business Solutions ICT analyzed WEBFLEET.connect requests for
roughly the last two years and revised the rules which are going to be put in place to not produce any
false positives which would negatively impact WEBFLEET.connect users. The precise date for this is to be
determined.
WEBFLEET.connect supports in addition to the PRO 9100 connected series also PRO 9150 devices. We
would like to highlight again that with the introduction of the PRO series last year there was a change to
the work time messages received through the WEBFLEET.connect Message Queue Service. When using
any connected PRO devices with driver logon you will receive the same work time messages as for a
TomTom Remote LINK Working Time.
We have upgraded the WEBFLEET reverse geo coding early in 2011. The WEBFLEET.connect API retained
in syntactical compatibility with respect to all raw geo location related data in the WEBFLEET.connect
Message Queue Service and other functions and data queries. The main benefits from a quality
perspective are improved post code support (we now include post codes wherever they are available),
intersection information, better maps, and increased worldwide map coverage (e.g. Australia, New
Zealand, more countries in sub-Sahara Africa).
3
Open as PDF
Similar pages