Przejdź do głównej zawartości

API do integracji z Guru Maps

Guru Maps obsługuje schematy guru:// i geo:// służące do integracji z innymi aplikacjami. Pozwalają one uruchamiać import plików i wyszukiwanie, rozpoczynać nawigację, sterować zapisem śladu oraz zapisywać bieżącą lokalizację.

Otwieranie Guru Maps​

API: guru:[?back_url=<url>]

Parametry:

  • back_url — jeśli jest ustawiony, naciśnięcie przycisku Escape otwiera podany zwrotny adres URL.

Przykłady:

  1. guru: — otwiera Guru Maps bez przerywania trwającej czynności.
  2. guru:?back_url=https://gurumaps.app — otwiera Guru Maps, a po naciśnięciu klawisza Escape otwiera https://gurumaps.app.

Import pliku​

API: guru://open?url=<url pliku>

Parametry:

  • url — adres URL pliku przeznaczonego do importu.

Guru Maps pobiera plik ze wskazanego adresu URL i próbuje go zaimportować. Obsługiwane formaty: GPX, KML, KMZ, WPT, PLT, TCX, MS, GeoJSON, MapCSS, SQLITEDB, MBTILES.

Przykłady:

  1. guru://open?url=https://gurumaps.app/example/feature_collection.geojson — importuje plik GeoJSON z podanego linku.
  2. guru://open?url=https://ms.gurumaps.app/ms/google/Google_Satellite_RU_HD.ms — importuje satelitarne źródło mapy z podanego linku.

Wyszukiwanie​

API: guru://search?q=<zapytanie>[&coord=lat,lon][&back_url=<url>][&back_url=<url>]

Parametry:

  • q — wyszukiwany tekst
  • coord — współrzędne punktu, wokół którego rozpocznie się wyszukiwanie, w formacie lat,lon. Jeśli ich nie podano, wyszukiwanie rozpocznie się od bieżącego położenia mapy.
  • back_url — jeśli jest ustawiony, naciśnięcie przycisku Escape otwiera podany zwrotny adres URL.

Przykłady:

  1. guru://search?q=Wybrzeże%20Kościuszkowskie%2020%20Warszawa&coord=52.2297,21.0122 — wyszukuje „Wybrzeże Kościuszkowskie 20 Warszawa” na mapie wyśrodkowanej na wskazanych współrzędnych.
  2. guru://search?q=Agrykola%201%20Warszawa — wyszukuje „Agrykola 1 Warszawa”, korzystając z bieżącego położenia mapy.

Nawigacja​

API: guru://nav?finish=lat,lon[&via=lat,lon][&start=lat,lon][&mode=<auto, bicycle, pedestrian, motor_scooter, motorcycle, truck, straight>][&start_navigation=<true,false>][&back_url=<url>]

Parametry:

  • finish — współrzędne punktu końcowego trasy.
  • via — współrzędne punktów pośrednich trasy. Można podać kilka punktów pośrednich.
  • start — współrzędne punktu początkowego trasy. Jeśli ich nie podano, używana jest bieżąca pozycja użytkownika.
  • mode — środek transportu (auto, bicycle, pedestrian, motor_scooter, motorcycle, truck, straight). Domyślnie używany jest tryb auto.
  • start_navigation — wartość true uruchamia nawigację natychmiast po wyznaczeniu trasy. Jeśli parametr nie został ustawiony albo ma wartość false, pojawi się ekran podglądu i edycji trasy.
  • back_url — jeśli jest ustawiony, naciśnięcie przycisku Escape otwiera podany zwrotny adres URL.

Przykłady:

  1. Wyznacz trasę od bieżącej pozycji do wskazanego punktu: guru://nav?finish=52.2297,21.0122
  2. Wyznacz trasę między dwoma wskazanymi punktami: guru://nav?start=52.2297,21.0122&finish=52.2397,21.0222
  3. Wyznacz trasę z punktem pośrednim: guru://nav?start=52.2297,21.0122&finish=52.2397,21.0222&via=52.2347,21.0172
  4. Wyznacz trasę z dwoma punktami pośrednimi: guru://nav?start=52.2297,21.0122&via=52.2347,21.0172&via=52.2765,21.234&finish=52.2397,21.0222
  5. Wyznacz trasę rowerową: guru://nav?start=52.2297,21.0122&finish=52.2397,21.0222&via=52.2347,21.0172&mode=bicycle
  6. Wyznacz trasę i natychmiast rozpocznij nawigację: guru://nav?start=52.2297,21.0122&finish=52.2397,21.0222&via=52.2347,21.0172&mode=bicycle&start_navigation=true
  7. Wyznacz trasę i po naciśnięciu Escape wróć pod wskazany adres URL: guru://nav?finish=52.2297,21.0122&back_url=https://gurumaps.app
  8. Wyznacz trasę, rozpocznij nawigację i po naciśnięciu Escape wróć pod wskazany adres URL: guru://nav?finish=52.2297,21.0122&start_navigation=true&back_url=https://gurumaps.app

Rozpoczynanie, zatrzymywanie i przełączanie zapisu śladu​

API: guru://recordTrack?action=<start,stop,toggle>

Parametry:

  • action — określa czynność dotyczącą zapisu śladu. Dostępne wartości: start, stop i toggle.

Przykłady:

  1. guru://recordTrack?action=start — rozpoczyna zapis śladu w Guru Maps.
  2. guru://recordTrack?action=stop — zatrzymuje trwający zapis śladu.
  3. guru://recordTrack?action=toggle — przełącza stan zapisu śladu. Jeśli zapis trwa, zostanie zatrzymany; w przeciwnym razie rozpocznie się nowy.
notatka

Jeśli podano nieprawidłową czynność albo nie podano jej wcale, API domyślnie użyje wartości toggle. Oznacza to, że guru://recordTrack działa tak samo jak guru://recordTrack?action=toggle.

Tworzenie pinezki​

API: guru://saveMarker[?name=<nazwa pinezki>][&coord=lat,lon]

Po utworzeniu pinezki Guru Maps otwiera ekran jej szczegółów.

Parametry:

  • name — nazwa pinezki. Jeśli jej nie podano, zostanie uzupełniona automatycznie.
  • coord — współrzędne pinezki. Jeśli ich nie podano, używana jest bieżąca pozycja użytkownika.

Przykłady:

  1. Utwórz pinezkę w bieżącej pozycji użytkownika: guru://saveMarker
  2. Utwórz pinezkę o podanej nazwie w bieżącej pozycji: guru://saveMarker?name=MyMarker
  3. Utwórz pinezkę we wskazanej pozycji: guru://saveMarker?coord=52.2297,21.0122
  4. Utwórz pinezkę o podanej nazwie we wskazanej pozycji: guru://saveMarker?name=MyMarker&coord=52.2297,21.0122

Wyświetlanie na mapie miejsca o podanych współrzędnych​

API: guru://show?place=lat,lon[,zoom][&back_url=<url>]

Parametry:

  • place — współrzędne miejsca wyświetlanego na mapie.
  • zoom — opcjonalnie: skala, w której ma zostać wyświetlony wybrany punkt. Jeśli jej nie podano, używana jest bieżąca skala mapy.
  • back_url — opcjonalnie: jeśli jest ustawiony, naciśnięcie przycisku Escape otwiera podany zwrotny adres URL.

Przykłady:

  1. guru://show?place=52.2297,21.0122 — otwiera Guru Maps i wyświetla wskazany punkt.
  2. guru://show?place=52.2297,21.0122,17 — otwiera Guru Maps i wyświetla wskazany punkt na 17. poziomie powiększenia.
  3. guru://show?place=52.2297,21.0122&back_url=https://gurumaps.app — otwiera Guru Maps, wyświetla wskazany punkt, a po naciśnięciu Escape otwiera https://gurumaps.app.
notatka

Guru Maps obsługuje również schemat geo:. Aby na przykład wyświetlić określoną lokalizację na mapie, użyj geo:52.2297,21.0122. Schemat geo: nie obsługuje jednak parametru back_url. Jeśli jest on potrzebny, użyj schematu guru://.