Customers looking to automate their processes and integrate OptimoRoute with other third party software can do this using our Web Service Application Programming Interface (API). This article gives a quick overview of what to expect when using the API.
| Who can use this feature | |
| Available for all plans | |
| Users that have administrator privileges | |
| All regions | |
Web service API
The web service API can be used to integrate ecommerce platforms, accounting software, and other business software with OptimoRoute and automate tasks such as importing orders, starting the optimization, and getting the information about planned routes from OptimoRoute.
OptimoRoute provides a flexible API for platform integration with client-side systems. Available actions include:
- Create, update or delete orders
- Plan routes
- Retrieve route and scheduling information back into the client-side system
- Update driver parameters, such as working hours, vehicle assignments, start and end location, etc.
- When your drivers go live, monitor their activity by receiving their live tracking events
- Retrieve completion details for an order, including all available proof of delivery data
- Use your own mobile app and send updates of order statuses and driver positions
Read the API documentation here.
Creating an authentication key
An authentication key is required for using OptimoRoute web service API.
To generate your authentication key:
- Go to Administration→Settings→Account→WS API
- Click the box to enable the API
Your unique key will be generated.
| You can only create one key. Disabling or regenerating the API key will cause any existing integrations to be disconnected. |