Standortkarte

Erstellen Sie Standortkarten, um diese auf Ihrer Webseite zu verwenden. Mithilfe der hier beschriebenen Schnittstelle können Sie Standortkarten in verschiedenen Formaten und Konfigurationen erstellen.

Entry Points

Der Service wird als GET-URL-Service zur Verfügung gestellt und kann somit verlinkt werden oder zum Beispiel als Inlineframe eingebunden werden.

URL

Der Kartenausschnitt wird durch eine zu geokodierende Adresse oder eine Koordinate vorgegeben:
https://location.smartmaps.app/?key={HIER API_KEY EINBINDEN}

Inlineframe

Codebeispiel: Einbinden per Inlineframe

<iframe src="https://location.smartmaps.app/?key={HIER API_KEY EINBINDEN}" style="height: 100%; width: 100%; border: 0;" title="SmartMaps"></iframe>

GET-Parameter

Parameter: Authentifizierung

Um die Standortkarte nutzen zu können, benötigen Sie einen API-Key. Diese erhalten Sie direkt von YellowMap bei der Registrierung. Diesen müssen Sie beim Parameter key übergeben.

Name Beschreibung Datentyp Standardwert
key API-Key (wird direkt von YellowMap bereitgestellt). string ""

Parameter: Allgemeine Maps Settings

Mit diesen Parametern kann das Verhalten und Aussehen der Karte angepasst werden. Die Parameter müssen URL-encoded übergeben werden.

Name Beschreibung Datentyp Standardwert
ch Channel: Eine Zeichenfolge, die protokolliert wird; sie kann vom Benutzer frei gewählt werden. String ""
fsc FullscreenControl: Ob die Karte im Vollbild-Modus geöffnet werden kann. bool false
zc ZoomControl: Ob und in welcher Ecke der Zoomregler standardmäßig zur Karte hinzugefügt wird. string

topleft

topright

bottomleft

bottomright
z Zoom: Ursprünglicher Zoom-Wert. int 1-19 19
minz Minzoom: Minimale Zoomstufe der Karte. int 1-19 4
maxz Maxzoom: Maximale Zoomstufe der Karte. int 1-19 19
swz ScrollWheelZoom: Ob die Karte mit dem Mausrad gezoomt werden kann. bool true
static Static: Karte lässt sich nicht bewegen oder zoomen. bool false
mh MapHeight: Gibt die Höhe der Karte an. Werte als px oder %. Wichtig: URL-enkodierte Werte. string 100%25
s Style: Einstellung des Kartenprofils, welches in der Karte angezeigt werden soll. Per default wird das Standardprofil lightmode von SmartMaps geladen. Sie können zwischen verschiedenen auf den jeweiligen Anwendungsfall angepasst, Profilen wählen. Bei Nutzung von auto wird abhängig von den Einstellungen des Endgeräts/Betriebssystems automatisch der Light- oder Darkmode verwendet.

auto,
light,
dark,
essential,
grey,
accessible

 light
tc Terrain-Control: Aktivierung des Terrain-Controls zur weltweiten Darstellung von Terraindaten. bool false

Parameter: Marker & Pop-up

Mit diesen Parametern kann das Verhalten und Aussehen von dem Marker und Pop-up angepasst werden. Die Parameter müssen URL-encoded übergeben werden.

Name Beschreibung Datentyp Standardwert
y Lat: Gibt den Breitengrad des Markers an. Wenn keine Adresse angegeben wird, wird die Koordinate geokodiert. number null
x Lng: Gibt den Längengrad des Markers an. Wenn keine Adresse angegeben wird, wird die Koordinate geokodiert. number null
zp Zip:Die Postleitzahl der zu geokodierenden Adresse. Wenn keine Koordinate angegeben wird, wird die Adresse geokodiert. String null
cty City:Die Stadt der zu geokodierenden Adresse. Wenn keine Koordinate angegeben wird, wird die Adresse geokodiert. String null
str Street:Die Straße der zu geokodierenden Adresse. Wenn keine Koordinate angegeben wird, wird die Adresse geokodiert. String null
hsn HouseNo:Die Hausnummer der zu geokodierenden Adresse. Wenn keine Koordinate angegeben wird, wird die Adresse geokodiert. String null
ic IsoCountry: Das Land der zu geokodierenden Adresse. Wenn keine Koordinate angegeben wird, wird die Adresse geokodiert. String "DE"
c Color: Die Farben der in der Karte einzuzeichnenden Marker. Vier hexadezimale Werte für den Rot, Grün und Blau und den Alpha-Kanal. #HEX-Color #18355b
is iconSize: Definiert die Größe des Markers. Werte sind S, M, L und XL String "M"
hp hasPopup: Definiert, ob der Marker ein Pop-up hat. bool true
pt header: Gibt die Kopfzeile des Pop-ups an. String ""
pb body: Gibt den Inhalt des Rumpfes des Pop-ups an. String ""
Hinweis: Für die Darstellung des Popups werden Adressinformationen erwartet. Wenn diese nicht über die dazugehörigen Parameter übergeben werden, erfolgt automatisiert eine reverse Geokodierung, um diese zu bestimmen. Damit das Geocoding durchgeführt werden kann, müssen Sie die Anwendungsdomain location.smartmaps.app für Ihren API-Key zusätzlich freischalten.