Header - Image Header - Image

TIMOCOM

API Integration Guide

Please find our current versions of the API documentations here.

Version: V3 (April 2023)

As mentioned in the Partner Agreement this API Integration Guide provides recommendations for the implementation as well as checklists, examples of integrations and best practices. The integration should be user-friendly, highly adapted to the daily work of the users and easy to handle.

Process-wise the Partner receives the documentations beforehand, checks the technical requirements and provides a draft on how to implement the specific API into its system/front-end. Finally, a member of the TIMOCOM Product Management and/or Partner Management will do a final assessment of the implementation.

Since the further development of APIs is constant, we look forward to new implementation ideas from our partners. This API Integration Guide will be updated, at least once a year, and provided to the Partner.

The Partner Agreement and our current version of the TIMOCOM terms and conditions have to be considered in the API integration process. This guide will give you insights and ideas on how to implement the API.

The technical integration of the APIs will be completed by doing a business approval together.

TIMOCOM Road Freight Marketplace

How is TIMOCOM’s Marketplace used without APIs and what are the basic advantages of using our APIs?

Not using integrated solutions via API means extra work because the data needs to be entered manually (freight offer/vehicle space offer) instead of automatically transmitting the data from the Partner’s system. With the Freight Exchange Offers API this time is saved and can be used otherwise.

If a user is constantly searching for freight or vehicle space, the user must define the search and refresh the search window regularly – why not save this extra work and time by automatically transmitting freight or vehicle space offers into the Partner’s system.

Thus, the API integration does not only save time due to less manual work but also provides faster searches and shortens reaction time on the spot market, where every extra second is a competitive advantage.

Furthermore, the user does not need to switch between applications but can work directly within the Partner’s system and exchange data with us in an efficient manner.
imagem-sls-data

 

Integration recommendations per API

API Freight Exchange

API Transport Orders

API Shipment

API Tracking

Update Process

The APIs are constantly being improved and further developed. As soon as new versions are available an updated documentation is sent to the Partner.

If changes to one of the TIMOCOM APIs require an update of the front-end/change in the agreed implementation, the Partner must provide a screenshot or online presentation of the changes in the system so it can be approved by the TIMOCOM Product Management and/or Partner Management.

Checklists for final approval

Generally:

Topic
Must
Should

Which of the APIs are implemented?

x  

Is the implemented solution user-friendly and therefore easy to use?

x  

Is a TIMOCOM logo / branding integrated?

  x

Explain the use / storage / deletion of data

x  

Communication process – any indication of spam mailing

x  

Data retrieval interval / explain the time settings

x  

 

API Freight Exchange (module: Offer)*

*Please note that following evaluation is based on best practices, customer feedbacks and our recommendations for a proper API integration

Topic
Must
Should
Create, edit, delete offers

x

 
Zip code concealing x  

Multi stop tour

x

 

Multi select

x  
Automatic transfer of offers  

x

Quotes for freight

 

x

Marking transmitted offers

x

 

Searching and offering at the same time

 

x

 

API Freight Exchange (module: Search)*

*Please note that following evaluation is based on best practices, customer feedbacks and our recommendations for a proper API integration

Topic
Must
Should
Searching for freight/vehicle space based on specific parameters x

 

 
2-step search function x  
Map based display of search results   x
Area search x  
Multiple search

x

 
Connecting phone software and e-mail client   x

 

Quotes for freight

 

x

Searching for return loads/additional loads

x

 

Searching for freight along planned route

 

x

Reservation function

 

x

 

 

API Transport Order*

*Please note that following evaluation is based on best practices, customer feedbacks and our recommendations for a proper API integration

Topic
Must
Should
Sending, Canceling transport orders x  
Retrieving and receiving order-related messages x  
Storage of service provider data   x
Retrieveing and receiving transport orders x  
Accepting, rejecting and canceling transport orders x  

 

API Shipment*

*Please note that following evaluation is based on best practices, customer feedbacks and our recommendations for a proper API integration

Topic
Must
Should
Receiving shipment data x  
Updating shipment data x  
Status information

x

 
Automated status messages via geofencing  

x

Calculation of estimated time of arrival (ETA)  

x

Document management

x

 

 

API Tracking*

*Please note that following evaluation is based on best practices, customer feedbacks and our recommendations for a proper API integration

Topic
Must
Should
Retrieving approved GPS devices x

 

Retrieving own GPS devices x  
Granting permission to third parties

x

 
Map-based display x  

Contact us

Please contact your partner manager to discuss any integration topics.

If you have any technical questions, please contact our technical support