MyRouteOnline API
Enhance your business with route-planning capabilities
Purpose:
- Connect your business with MyRouteOnline for route-planning optimization.
- Allow external applications (ERM, CRM, etc.) to partially automate the routing process.
- Automatically upload addresses, routing requirements.
- Automatically download routes and route planning results.
An example of MyRouteOnline API implementation is the MyRouteOnline Excel Add-in uploads addresses from Excel into MyRouteOnline using MyRouteOnline API.
Notes:
- Supports most backoffice ERP CRM systems such as SalesForce, Excel, QuickBooks etc..
- The API is free with any of our pricing plans.
- The API provides semi-automation of your routing process, but manual steps are still involved.
- Contact us is you have any specific questions or interesets.
- We will gladly walk you through the implementation process.
- We also provide a full Web-Service REST API. Contact us for more details.
How to use the MyRouteOnline API
Required skills for the setup of the MyRouteOnline API:
- Basic programming skills
- Basic understanding of web-services
Web-Service url (SOAP/WSDL):
https://planner.myrouteonline.com/MyRouteOnline/AutomationApi/AutomationApi.asmx
- UploadInputData
- DownloadInputData
The Web-Service consists of 2 main methods along with several utility methods.
Step 1: UploadInputData – Upload addresses & routing parameters
- Call the method UploadInputData to upload the addresses and parameters (you will also supply a secret pin number (pick any number) to be used later when you launch the route-planner)
- The API response includes the token to be used in step 2.
- This step is usually performed by your server side logic.
Step 2: User Action & Process
- A browser window should be opened (by your client side logic) in a specified url along with the token (from step 1).
- The addresses and parameters are automatically loaded.
- Manually start the route-planning and see the optimized route(s) on the map.
- The browser should be launched with this url format: (as an example token = ABCDEF and pin = 12345)
http://planner.myrouteonline.com?pin=12345&dataid=ABCDEF
- Only after the route-plan is finished and visible on the map – you can proceed to step 3.
Step 3 (optional): DownloadInputData – Download the route planning results
- Only after you successfully finished Step 2 and you saw the route-plans on the map
- Call DownloadRoutePlanResult to download the route-plan results via the web-service API call.
- The route must be computed in step 2 in order for the route-plan results to be available for download.
Use the same token that you received in Step 1.
- This step is usually performed by your server side logic.
Notes:
- The login is performed in step 2 by the user.
- If you wish to login on-behalf of a user – the API provides the method GetLoginToken to call before step 1 and then pass the login-token in step 2 as url-parameter “logintoken”.
Contact us if you have any specific requirements or if you need any further assistance.