Difference between revisions of "Deeplink"
(Change tld and add language parameter) |
m |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | Deeplinking is opening the website with addresses. This is the most easy way of connecting your system to our route planner. You add addresses to the URL, which are automatically recognized, imported to the map and optimized. | + | Deeplinking is opening the website with addresses. This is the most easy way of connecting your system to our route planner. You add addresses to the URL, which are automatically recognized, imported to the map and optimized. For seamless integration, check our [[API]]. |
== URL format == | == URL format == | ||
| Line 5: | Line 5: | ||
To load addresses automatically, add addresses to the URL in this format: | To load addresses automatically, add addresses to the URL in this format: | ||
| − | + | www.routexl.com/?q=<address1>$<address2>$<address3>$<address4> | |
| − | In other words, using the parameter '''q''' and seperating with a dollar sign. Addresses need to be urlencoded. | + | In other words, using the parameter '''q''' and seperating with a dollar sign. Addresses need to be [https://www.php.net/manual/en/function.urlencode.php urlencoded]. A minimum of three adresses is required. |
| + | |||
| + | === Optional parameters === | ||
To change the language of the website, add the parameter '''lang''': | To change the language of the website, add the parameter '''lang''': | ||
| − | + | www.routexl.com/?q=<address1>$<address2>$<address3>$<address4>&lang=en | |
| − | + | ||
| + | By default the deeplink will find a roundtrip. The first address is also the endpoint of the route. To have the route end at the last address, add the parameter '''roundtrip''' and set it to ''false''. When ending at the last address, a minimum of four addresses is required. | ||
| + | |||
| + | www.routexl.com/?q=<address1>$<address2>$<address3>$<address4>&roundtrip=false | ||
| + | |||
| + | === Additional fields === | ||
| + | |||
| + | This is experimental, but you can add additional fields to each address. E.g. name of the stop, its servicetime, time slot and comments. To add these fields, use the same [[Import|import formatting]]. Additional fields must be urlencoded with the address. | ||
| + | |||
| + | === Auto login === | ||
| + | |||
| + | If your deeplink has more than 20 stops, you'll need to be logged in with an upgraded account. To make sure someone is logged in when opening the deeplink, use the login with redirect: | ||
| + | |||
| + | www.routexl.com/blog/wp-login.php?redirect_to=<redirect_url> | ||
| + | |||
| + | Note that the redirect url must be urlencoded on itself. As a result the addresses in the deeplink are urlencoded twice. E.g. space %20 becomes %2520. | ||
| + | |||
== Example == | == Example == | ||
| − | https://www.routexl. | + | https://www.routexl.com/?q=Jan%20Ligthartstraat%201%2C%20Alkmaar%24Markt%2011%2C%20Arnhem%24Martinikerkhof%2012%2C%20Groningen%24Snekertrekweg%201%2C%20Leeuwarden%24Westerbrink%201%2C%20Assen%24Luttenbergstraat%202%2C%20Zwolle%24Visarenddreef%201%2C%20Lelystad%24Pythagoraslaan%20101%2C%20Utrecht%24Houtplein%2033%2C%20Haarlem%24Zuid-Hollandplein%201%2C%20Den%20Haag%24Abdij%206%2C%20Middelburg%24Brabantlaan%201%2C%20Hertogenbosch%24Limburglaan%2010%2C%20Maastricht&lang=en |
| + | |||
| + | Coordinates can also be used, but the route optimization does not launch automatically: | ||
| + | |||
| + | https://www.routexl.com/?q=52.596433%2C4.708673%2452.375000%2C4.630823%2452.087104%2C4.317073%2451.500536%2C3.615379%2450.838986%2C5.702122%2451.678092%2C5.330025%2451.977267%2C5.909866%2452.509611%2C6.104196%2452.985670%2C6.538857%2453.219812%2C6.569814%2453.196178%2C5.786209%2452.506646%2C5.471510%2452.092421%2C5.149157%2452.596433%2C4.708673%24&lang=en | ||
| + | |||
| + | == ChatGPT == | ||
| + | |||
| + | You can use [https://en.wikipedia.org/wiki/Artificial_intelligence Artificial Intelligence] (AI) systems to generate the deeplink for you. This allows a system like [https://chat.openai.com ChatGPT] to map your addresses on our website and launch the routing algorithm to find the fastest route. The prompt to use is: | ||
| + | |||
| + | ''RouteXL is a multi stop route planner website. It has a deeplink feature to add addresses in its URL and find the fastest route. To create the deeplink you must add a parameter "q" with all addresses URL-encoded and separated with a "$" character. Generate this deeplink to find the best route to my addresses: <add your addresses here>'' | ||
Latest revision as of 09:34, 30 September 2024
Deeplinking is opening the website with addresses. This is the most easy way of connecting your system to our route planner. You add addresses to the URL, which are automatically recognized, imported to the map and optimized. For seamless integration, check our API.
Contents
URL format
To load addresses automatically, add addresses to the URL in this format:
www.routexl.com/?q=<address1>$<address2>$<address3>$<address4>
In other words, using the parameter q and seperating with a dollar sign. Addresses need to be urlencoded. A minimum of three adresses is required.
Optional parameters
To change the language of the website, add the parameter lang:
www.routexl.com/?q=<address1>$<address2>$<address3>$<address4>&lang=en
By default the deeplink will find a roundtrip. The first address is also the endpoint of the route. To have the route end at the last address, add the parameter roundtrip and set it to false. When ending at the last address, a minimum of four addresses is required.
www.routexl.com/?q=<address1>$<address2>$<address3>$<address4>&roundtrip=false
Additional fields
This is experimental, but you can add additional fields to each address. E.g. name of the stop, its servicetime, time slot and comments. To add these fields, use the same import formatting. Additional fields must be urlencoded with the address.
Auto login
If your deeplink has more than 20 stops, you'll need to be logged in with an upgraded account. To make sure someone is logged in when opening the deeplink, use the login with redirect:
www.routexl.com/blog/wp-login.php?redirect_to=<redirect_url>
Note that the redirect url must be urlencoded on itself. As a result the addresses in the deeplink are urlencoded twice. E.g. space %20 becomes %2520.
Example
Coordinates can also be used, but the route optimization does not launch automatically:
ChatGPT
You can use Artificial Intelligence (AI) systems to generate the deeplink for you. This allows a system like ChatGPT to map your addresses on our website and launch the routing algorithm to find the fastest route. The prompt to use is:
RouteXL is a multi stop route planner website. It has a deeplink feature to add addresses in its URL and find the fastest route. To create the deeplink you must add a parameter "q" with all addresses URL-encoded and separated with a "$" character. Generate this deeplink to find the best route to my addresses: <add your addresses here>
