- Developers
- Professional Navigation for Fleets
- iOS
- Custom URL
Custom URL
Introduction
With the iOS Custom URL scheme you can implement a simple integration of your application with Sygic Truck or Professional navigation.
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 supported 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 or country ISO code | city | postal | street | house number | type | com.sygic.aura://address|SVK|Bratislava|85101|Einsteinova|21|show |
| drive to an address | com.sygic.aura/address | country or country ISO code | city | postal | street | house number | type | com.sygic.aura://address|SVK|Bratislava|85101|Einsteinova|21|drive |
| walk to an address | com.sygic.aura/address | country or country ISO code | city | postal | street | house number | type | com.sygic.aura://address|SVK|Bratislava|85101|Einsteinova|21|walk |
| show map on coordinates | com.sygic.aura://coordinate | lon | lat | type | com.sygic.aura://coordinate|15.06591|47.73341|show |
| drive to coordinates | com.sygic.aura://coordinate | lon | lat | type | com.sygic.aura://coordinate|15.06591|47.73341|drive |
| walk to coordinates | com.sygic.aura://coordinate | lon | lat | type | com.sygic.aura://coordinate|15.06591|47.73341|walk |
| drive to coordinates with defining address description | com.sygic.aura://coordinateaddr | lon | lat | address_description | type | com.sygic.aura://coordinateaddr|15.06591|47.73341|Customer John Smith|drive |
| 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 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. |
com.sygic.aura://update|fra com.sygic.aura://update|all |
| show sygic products' shop | com.sygic.aura://mysygic | com.sygic.aura://mysygic |
| buy a license for a product | com.sygic.aura://mysygicbuy | productId | com.sygic.aura://mysygicbuy|14307 |
| 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 back button behavior | com.sygic.aura://back_button | application identifier | com.sygic.aura://back_button|com.android.chrome |
| 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 |
Truck settings parameter string
| key | description | Example |
|---|---|---|
| mxs | defines maximum speed in km/h | mxs=90 |
| wei | defines total weight in kilograms | wei=15000 |
| axl | 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 |
| 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 |
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
Supported universal URL schemes for Consumers
The schemes are valid only for Consumers Sygic GPS Navigation.
| name | URL scheme | Example |
|---|---|---|
| open search with results | https://go.sygic.com/search? where -q search query (address, postal code, coordinates) / actual position is center by default -center coordinates of center location for search (optional parameter) |
https://go.sygic.com/search?q=Restaurant https://go.sygic.com/search?q=Restaurant¢er=49.2194,18.7408 |
| start route planner | https://go.sygic.com/directions? where -to destination coordinates -from start coordinates (optional parameter) -via[] waypoint coordinates (optional parameter) -mode car|walk|van (optional parameter) |
https://go.sygic.com/directions?from=49.209,16.591&to=49.2194,18.7408 https://go.sygic.com/directions?to=48.145887,17.127227&via[]=49.169,16.626&via[]=48.139,17.108 |
| search and open first valid result in POI detail | https://go.sygic.com/place? where -q search query -coordinates coordinates of POI |
https://go.sygic.com/place?q=Bratislava https://go.sygic.com/place?coordinates=49.2194,18.7408 |
| open Sygic store for an item | https://go.sygic.com/store? where -product tag of the item in store -productId id of the item in store |
https://go.sygic.com/store?productId=123 https://go.sygic.com/store?product=dashcam |
| open WEB view for URL | https://go.sygic.com/web? where -url the url |
https://go.sygic.com/web?url=https://www.sygic.com |
| open login | https://go.sygic.com/sign-in | https://go.sygic.com/sign-in |
| open manage maps | https://go.sygic.com/manage-maps | https://go.sygic.com/manage-maps |
| open travel insurance | https://go.sygic.com/travel-insurance | https://go.sygic.com/travel-insurance |
| open EV mode | https://go.sygic.com/ev | https://go.sygic.com/ev |
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.