- Developers
- Professional Navigation for Fleets
- Android
- API
- Custom URL
Custom URL
Introduction
With the Android Custom URL scheme you can implement a simple integration of your application with Sygic navigation.
Example with Android programming
With your Android application you can start the Sygic navigation and directly open it on a specified address using this snippet.
String lon = "17.12812";
String lat = "48.15594";
String type = "drive";
String str = "com.sygic.aura://coordinate|" + lon + "|" + lat + "|" + type;
startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(str)));Example using HTML
This HTML web page example shows 4 hyperlinks to start Sygic navigation for showing the predefined locations and driving to the locations.
<body>
SLOVAKIA 48.159673,17.111206
<a href="com.sygic.aura://coordinate|17.12812|48.15594|show">Sygic show</a>
<a href="com.sygic.aura://coordinate|17.12812|48.15594|drive">Sygic navigate to</a>
USA (Illinois) 41.87985,-87.636395
<a href="com.sygic.aura://coordinate|-87.636395|41.87985|show">Sygic show</a>
<a href="com.sygic.aura://coordinate|-87.636395|41.87985|drive">Sygic navigate to</a>
</body>List of Sygic Custom URL schemes
Please note that for majority of uses the parameter string needs to be URL-encoded (so called percent encoding).
It normally relates to the following characters: "#%<>[]^`{|} and the SPACE. For exact rules check the documentation on Encoding
Example: Instead of com.sygic.aura://route_download|http://dat.my.com/my route.sif
use com.sygic.aura://route_download%7Chttp%3A%2F%2Fdata.my.com%2Fmy%20route.sif
| name | URL scheme | Example |
|---|---|---|
| search an address or place | com.sygic.aura://search | searched address | com.sygic.aura://search|Bratislava%20Einsteinova%2021 |
| search an address or place and drive | com.sygic.aura://search | searched address | drive | com.sygic.aura://search|Bratislava%20Einsteinova%2021|drive |
| show map on an address | com.sygic.aura/address | country | city | postal | street | house number | type | com.sygic.aura://address|Slovakia|Bratislava|85101|Einsteinova|21|show |
| drive to an address | com.sygic.aura/address | country | city | postal | street | house number | type | com.sygic.aura://address|Slovakia|Bratislava|85101|Einsteinova|21|drive | drive to an address using the first route | com.sygic.aura/address | country | city | postal | street | house number | type | com.sygic.aura://address|Slovakia|Bratislava|85101|Einsteinova|21|driveNow |
| show map on coordinates | com.sygic.aura://coordinate | lon | lat | type | com.sygic.aura://coordinate|17.12812|48.15594|show |
| drive to coordinates | com.sygic.aura://coordinate | lon | lat | type | com.sygic.aura://coordinate|17.12812|48.15594|drive | drive to coordinates using the first route | com.sygic.aura://coordinate | lon | lat | type | com.sygic.aura://coordinate|17.12812|48.15594|driveNow |
| drive to coordinates with defining address description | com.sygic.aura://coordinateaddr | lon | lat | address_description | type | com.sygic.aura://coordinateaddr|17.12812|48.15594|Customer John Smith|drive | drive to coordinates with defining address description using the first route | com.sygic.aura://coordinateaddr | lon | lat | address_description | type | com.sygic.aura://coordinateaddr|17.12812|48.15594|Customer John Smith|driveNow |
| loads json itinerary | com.sygic.aura://route | file (sif or json) | com.sygic.aura://route|myitinerary.sif |
| downloads json itinerary and loads it to navigation | com.sygic.aura://route_download | url | type where type can have values: sif - Sygic itinerary format, or Sygic precomputed route format json - PTV json format bcr - PTV bcr format |
com.sygic.aura://route_download|http://test.com/routes/myroute.sif|sif check encoding rules |
| opens web page directly in navigation | com.sygic.aura://url | webpage | com.sygic.aura://url|www.shmu.sk |
| activate license with product code | com.sygic.aura://activate|productCode | com.sygic.aura://activate|2637-A356-563C-F156 |
| start navigation and login with username | com.sygic.aura://login | username | password | com.sygic.aura://login|jsmith@company.com|$js!PsW |
| update specific map or all maps | com.sygic.aura://update | map | *force* Note: the call starts downloading maps immediately but removes old maps with the application restart. This means that at the certain moment both maps are present in your filesystem, so your memory limits can be hit. Note2: *force* parameter is optional and if set, the update or fresh download of the map/maps will proceed automatically in the background, without any prompt (such as no-wifi connection dialog), no matter the settings |
com.sygic.aura://update|fra|*force* com.sygic.aura://update|all|*force* |
| show sygic products' shop | com.sygic.aura://mysygic | com.sygic.aura://mysygic |
| show product detail from shop | com.sygic.aura://mysygicproduct | productId | com.sygic.aura://mysygicproduct|22945 |
| buy a license for a product | com.sygic.aura://mysygicbuy | productId | com.sygic.aura://mysygicbuy|22945 |
| play gps nmea log from Res/gpslogs | com.sygic.aura://gpslog | nmeafile | com.sygic.aura://gpslog|mytraveltest.nmea |
| control truck settings (available since 13.6.0) |
com.sygic.aura://truckSettings | parameterstring where parameterstring is of the form key1=value1&key2=value2&... for details, see the table bellow. |
com.sygic.aura://truckSettings|rou=car com.sygic.aura://truckSettings|rou=cmp com.sygic.aura://truckSettings|mxs=90&rou=tru com.sygic.aura://truckSettings|mxs=110&len=8000&wid=2450&hei=3450&axw=1200&wei=15000&rou=tru com.sygic.aura://truckSettings|mxs=100&len=10000&wid=2450&hei=3200&axw=2200&wei=15550&rou=tru |
| Define vehicle profile | com.sygic.aura://vehicleProfileSettings | parameterstring where parameterstring is of the form key1=value1&key2=value2&... for details, see the table bellow. |
com.sygic.aura://vehicleProfileSettings|mxs=130&wei=7500&axw=3500&len=6000&wid=2450&
hei=2900&veh=van&profile=1&profileName=OversizeVan&emiss=5&year=2019 |
| define back button behavior | com.sygic.aura://back_button | application identifier | com.sygic.aura://back_button|com.android.chrome |
| overwrite app settings | com.sygic.aura://settingsOverwrite | filepath |
com.sygic.aura://settingsOverwrite|%2Fsdcard%2Fsettings_overload.ini com.sygic.aura://settingsOverwrite|%2Fsdcard%2Fmenu_overload.ini |
| get device code | com.sygic.aura://deviceCode | com.sygic.aura://deviceCode |
| control head-up display | com.sygic.aura://hud | command where the command can be of the values: none, normal, inverted none reverts the display to the standard navigation mode |
com.sygic.aura://hud|none com.sygic.aura://hud|normal com.sygic.aura://hud|inverted |
| remote activation | com.sygic.aura://activate | SDpassword | ProductID | Period | Description where password, product id and period should be consulted with Sygic support |
com.sygic.aura://activate|43tgs36f|1506|12|my activation batch 17 |
| set language | com.sygic.aura://setLanguage | ISO | Type | VoicePack where ISO is defined in ISO 639-1 format Type can be of the values Lang, Voice, LangVoice VoicePack can be of the values NormalMale, NormalFemale, TTS In case of Type=Lang the VoicePack setting is dontcare. In case of VoicePack=NormalMale of NormalFemale the voice pack needs to be downloaded in the application otherwise no change is done |
com.sygic.aura://setLanguage|en-GB|LangVoice|TTS |
| Download POI files and load it to navigation | com.sygic.aura://poi_download | url | com.sygic.aura://poi_download|http://test.com/pois/mypois.rupi check encoding rules |
| Create a route itinerary and load it to the navigation | com.sygic.aura://routeimport | url-encoded-data | type where type can have values: sif - Sygic itinerary format, or Sygic precomputed route format json - PTV json format bcr - PTV bcr format gwp - Google waypoint polyline (concise itinerary format) gep - Google encoded polyline (concise precomputed route format) |
com.sygic.aura://routeimport|%7B%0A%20%22version%2C%22%3A%20%223.0
%22%2C%0A%20%22directives%22%3A%7B%0A%20%20%20%22routeComputeType %22%3A%22truck%22%2C%0A%20%20%20%22routeComputeMethod%22%3A%22 fastest%22%2C%0A%20%20%20%22avoids%22%3A%7B%0A%20%20%20%20%20%22 tollroadsGlobal%22%3A%20false%2C%0A%20%20%20%20%22motorwaysGlobal %22%3A%20false%2C%0A%20%20%20%20%22boatferryGlobal%22%3A%20true %2C%0A%20%20%20%20%22tollroads%22%3A%5B%20%22aut%22%2C%20%22deu %22%20%5D%2C%0A%20%20%20%20%20%22motorways%22%3A%5B%20%22aut %22%2C%20%22deu%22%20%5D%2C%0A%20%20%20%20%20%22countries %22%3A%5B%20%22hun%22%2C%20%22ita%22%20%5D%0A%20%20%20%7D%2C%0A%20%20%22 vehicleRestrictions%22%3A%7B%0A%20%20%20%20%20%22width %22%3A%202000%2C%0A%20%20%20%20%22height%22%3A%202000%2C%0A%20%20%20%20%22 totalLength%22%3A%207000%2C%0A%20%20%20%20%22weight %22%3A%203700%0A%20%20%7D%0A%7D%2C%0A%22routeParts %22%3A%5B%0A%20%20%20%7B%0A%20%20%20%20%22waypointFrom %22%3A%7B%0A%20%20%20%20%20%20%20%22lon%22%3A%201711741%2C %0A%20%20%20%20%20%20%22lat%22%3A%204815311%2C%0A%20%20%20%20%20%20%22 type%22%3A%22start%22%0A%20%20%20%20%20%7D%2C%0A%20%20%20%20%22waypointTo %22%3A%7B%0A%20%20%20%20%20%20%20%22lon%22%3A%201712142 %2C%0A%20%20%20%20%20%20%22lat%22%3A%204815532%2C%0A%20%20%20%20%20%20%22type %22%3A%22via%22%0A%20%20%20%20%20%7D%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20% 20%20%22waypointTo%22%3A%7B%0A%20%20%20%20%20%20%20%22lon%22%3A%201712143 %2C%0A%20%20%20%20%20%20%22lat%22%3A%204815533%2C%0A%20%20%20%20%20%20%22type %22%3A%22via%22%0A%20%20%20%20%20%7D%0A%20%20%7D%2C%0A%20%20%7B%0A%20%20%20 %20%22waypointTo%22%3A%7B%0A%20%20%20%20%20%20%20%22lon%22%3A%201712144 %2C%0A%20%20%20%20%20%20%22lat%22%3A%204815534%2C%0A%20%20%20%20%20%20%22 type%22%3A%22finish%22%0A%20%20%20%20%20%7D%0A%20%20%7D%0A%20%5D%0A%7D|sif check encoding rules |
| Download settings_overload.ini and load it to navigation | com.sygic.aura://settings_download|url | com.sygic.aura://settings_download|http%3A%2F%2Fstorage.sygic.com%2Ftmp%2FFLEET%2Fcustomers%2FFancourier%2Fsettings_overload.ini |
Truck settings parameter string
| key | description | Example |
|---|---|---|
| mxs | defines maximum speed in km/h | mxs=90 |
| wei | defines total weight in kilograms | wei=15000 |
| axw | defines maximum axle weight in kilograms | axw=1200 |
| len | defines length in milimeters | len=7800 |
| wid | defines width in milimeters | wid=2450 |
| hei | defines height in milimeters | hei=3450 |
| rou | defines routing type, where the possible values are: car, tru (truck), cmp (camper), van |
rou=tru |
| general | 1 defines turning the general hazmats on, 0 clears the setting | general=1 |
| water | 1 defines turning the water hazmats on, 0 clears the setting | water=1 |
| hClass | defines the setting of US hazmat classes. The possible values are 1,2,3,4,5,6,7,8,9,I. The values can be combined. The value 0 clears the setting to none. |
hClass=148 |
| adr | defines the setting of ADR tunnel class. The possible values are B,C,D,E. The values cannot be combined. The value 0 clears the setting to none. |
adr=B |
| profile | defines the profile id the new truck settings to be applied to, while the particular profile is also set active. The default is the profile 1. |
profile=2 |
| profileName | defines the profile name of the selected vehicle profile. | profileName=Long Haul Truck |
| emiss | defines the vehicle's emission category. The possible values are: 1,2,3,4,5,6 | emiss=5 |
| year | defines the vehicle's production year. The values are in the form of 2016, 2017, etc | year=2017 |
Supported standard Android Geo URI schemes
Except for the Sygic URL schemes we also support standard Android custom URI schemes for geo functionality.
| key | description | Example |
|---|---|---|
| geo lat/lon | geo:latitude,longitude | geo:48.12345,17.12345 |
| geo lat/lon with zoom | geo:latitude,longitude?z=zoom | geo:48.12345,17.12345?z=11 |
| geo with marker | geo:0,0?q=lat,lng(label) | geo:0,0?q=48.12345,17.12345(Treasure) |
| geo with address | geo:0,0?q=my+street+address | geo:0,0?q=slovakia,+bratislava,+karadzicova,+14 |
| navigation to lat/lon | google.navigation:q= | google.navigation:q=Haanova+1%2C+851+04+Bratislava&mode=b&ll=48.12345,17.12345 google.navigation:q=Haanova+1%2C+851+04+Bratislava&mode=w&ll=48.12345,17.12345 google.navigation:q=Haanova+1%2C+851+04+Bratislava&mode=d&ll=48.12345,17.12345 |
Multiple actions in one call
It is possible to chain several actions within a single URL call using the &&& sign.
Example: com.sygic.aura://login|username|password&&&back_button|package
How to use custom URL converted to QR codes
This easy method can be used to simply set some of the required parameters by reading QR code, placed e.g. on a dashboard, vehicle information card, etc.
Potential use:
- Vehicle profiles (Van, Delivery Truck, Heavy Weight Truck)
- Vehicle dimensions (useful when the same device is being used on multiple vehicles)
- Opening custom webpages
- Triggering map updates
Example 1: Open custom webpage directly with navigation application
template: com.sygic.aura://url | webpage
com.sygic.aura://url|www.sygic.sk
Example 2: Update specific map or all installed maps
template: com.sygic.aura://update | map
com.sygic.aura://update|gbr
com.sygic.aura://update|all
Example 3: Change vehicle profile settings
template: com.sygic.aura://truckSettings | parameterstring
com.sygic.aura://truckSettings|mxs=97&len=7900&wid=2400&hei=2600&axw=3600&wei=7500&rou=tru
For more information please contact your dedicated business representative or Sygic support contact
License terms
Integrating with the Custom URL scheme is restricted to Personal usage.
For Commercial usage of the URL scheme please contact our sales representatives.
- Previous article: Municipal API for 2D
