Parametry główne

W celu przekazania informacji do iframe’a należy przekazać parametry za pomocą metody GET. Najważniejszym parametrem pozwalającym na korzystanie z iframe’a jest authToken, czyli token uwierzytelniający. Token należy uzyskać w drodze logowania poprzez API: http://wiki.hogs.live/autoryzacja-2/.

Parametr mode definiuje, w jakim trybie ma zostać uruchomiony iframe, tzn. jakie funkcjonalności ma oferować, np. mode= calculateRoute będzie oznaczał tryb wyznaczania trasy. Parametrem uzupełniającym jest options, który zawiera wszystkie informacje potrzebne do odpowiedniego zachowania iframe’a, np. parametry charakteryzujące trasę.

<iframe src="https://iframe.hogs.live/?authToken=<authToken>&mode=<mode>&options=<options>"></iframe>

ParametrRodzaj wartościUwagi
authToken string token autoryzujący
mode string Parametr określający, w jakim trybie iframe ma zostać uruchomiony, np. tryb wyznaczania trasy.
options string JSON w formacie tekstowym z ustawieniami odpowiedniego trybu mapy.
centerMap {„lng”: string | number, „lat”:string | number} Współrzędne, nad jakimi ma się wycentrować mapa, np. {„lng”:”9.99183″,”lat”:”53.55375″}. Parametr opcjonalny.
zoom number Przybliżenie, z jakim ma się wczytać mapa, np. 12. Parametr opcjonalny.
lang ENG | DEU | CZE | ESP | FRA | POL | RUS | UKR Język aplikacji. Domyślna wartośc: ENG.