Difference between revisions of "API"

From RouteXL
Jump to: navigation, search
(Outline)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
The RouteXL API allows programmatic access to our route optimization algorithm. Using the API you can connect systems directly, without the need to use the public website. The API is meant for developers.
+
The RouteXL API allows programmatic access to our route optimization algorithm. Using the API you can connect systems directly, without the need to use the public website. The API is meant for developers. A simple alternative is our [[deeplink]].
  
 
== Outline ==
 
== Outline ==
  
* The API needs locations as positions with lat/lng coordinates.
+
* The input must be locations as positions (lat/lng coordinates).
* It returns distance tables and routes.
+
* Returned are distance tables and routes.
 
* Routes are the locations in optimized order, including cumulative distance and arrival times.
 
* Routes are the locations in optimized order, including cumulative distance and arrival times.
 
* Authorization is required, with username and password of the public website.
 
* Authorization is required, with username and password of the public website.
 
* You can optimize only one route at a time.
 
* You can optimize only one route at a time.
 
* Free use for routes up to 10 stops.
 
* Free use for routes up to 10 stops.
* If you need more stops per route you can [[upgrade]].
+
* If you need more stops per route you can [[Upgrades|upgrade]].
  
 
== Documentation ==
 
== Documentation ==
  
The API is documented at http://www.routexl.com/api/
+
The API is documented at https://www.routexl.com/api/

Latest revision as of 09:37, 30 September 2024

The RouteXL API allows programmatic access to our route optimization algorithm. Using the API you can connect systems directly, without the need to use the public website. The API is meant for developers. A simple alternative is our deeplink.

Outline

  • The input must be locations as positions (lat/lng coordinates).
  • Returned are distance tables and routes.
  • Routes are the locations in optimized order, including cumulative distance and arrival times.
  • Authorization is required, with username and password of the public website.
  • You can optimize only one route at a time.
  • Free use for routes up to 10 stops.
  • If you need more stops per route you can upgrade.

Documentation

The API is documented at https://www.routexl.com/api/