Backend-Service

Die Backend-Services sind eigenständige Services. Hierbei handelt es sich um eine Enterprise-Funktion der SmartMaps. Die Funktionalität ist in SmartMaps FREE nicht verfügbar. Für die Freischaltung eines Dienstes und weiteren Fragen stehen wir Ihnen gerne in unserem Supportbereich zur Verfügung.

Statische Karten REST

Erstellen Sie statische Karten, um diese auf Ihrer Webseite oder in einem Mailing zu verwenden. Mit Hilfe der hier beschriebenen Schnittstelle können Sie statische Karten in verschiedenen Formaten und Konfigurationen erstellen, folgende Funktionen stehen Ihnen zur Verfügung:

  • Einstellung verschiedener Kartengrößen und Zoomstufen anhand eines beliebigen Radius
  • Wahl der Maßstabseinheit (Meter/Kilometer oder Yard/Miles)
  • Einzeichnen von Punktdaten und Auswahl verschiedener Icons
  • Einzeichnen von selbstdefinierten Linien
  • Einzeichnen von automatisch geocodierten Adressen

Entry Points

Der Service wird als Standard-REST-Service zur Verfügung gestellt. Folgende mapBy-Service-Typen gibt es:

Der Kartenausschnitt wird durch ein Koordiantenpaar und einen Radius vorgegeben:
https://www.yellowmap.de/api_rst/v2/geojson/mapByLocation

Der Kartenausschnitt wird durch ein umgebendes Rechteck vorgegeben:
https://www.yellowmap.de/api_rst/v2/geojson/mapByRect

Der Kartenausschnitt wird durch eine zu geokodierende Adresse und einen Radius vorgegeben:
https://www.yellowmap.de/api_rst/v2/geojson/mapByAddress

Der Kartenausschnitt wird durch eine Punktwolke vorgegeben oder einen einzelnen Punkt zusammen mit einem Radius:
https://www.yellowmap.de/api_rst/v2/geojson/mapByPoints

Authentifizierung

Um die Schnittstelle verwenden zu können, benötigen Sie einen API-Key oder Ihren Partnernamen und den dazugehörigen Zugriffsschlüssel. Letztere erhalten Sie von YellowMap. Zur Authentifizierung werden die jeweiligen Zugangsdaten als URL-Parameter übergeben. Die Werte sind stets URL-enkodiert zu übermitteln.

Authentifizierung mittels API-Key

Parameter Bedeutung
apiKey API-Key – erhalten Sie nach Registrierung.

POST https://www.yellowmap.de/api_rst/v2/geojson/mapBy%TYPE%?apiKey=XXXX

Authentifizierung mittels Partnername und Sicherheitsschlüssel

Parameter Bedeutung
systemPartner Partnername – gibt YellowMap vor.
securityId Zugriffsschlüssel – gibt YellowMap vor.

POST https://www.yellowmap.de/api_rst/v2/geojson/mapBy%TYPE%?systemPartner=XXXX&securityID=XXXX

Statuscodes

Statuscode Bedeutung
BadRequest Das Format des Parameterwertes ist nicht valide. Es wird lediglich der Statuscode zurückgeliefert ohne Seiteninhalte.
Forbidden Der Zugriff ist aufgrund von Sicherheitsbestimmungen nicht erlaubt.
InternalServerError Softwarefehler. Zusätzlich zum Statuscode wird noch ein Bild zurückgeliefert, das auf den Fehler hinweist.
MethodNotAllowed Die angeforderten Produktmerkmale stehen nicht zur Verfügung.
NotAcceptable Der Parameterwert ist ungültig, zum Beispiel wird ein nicht unterstütztes Bildformat angefordert.
OK
Unauthorized Der Zugriffsschlüssel ist falsch oder ungültig.

Rückgabe

Codebeispiel: Karte einzeichnen

{
    "properties": {
        "exception": {
            "errCode": "",
            "publicReport": ""
        }
    },
    "features": [
        {
            "properties": {
                "width": "500",
                "height": "500",
                "url": "http://www.yellowmap.de/maps17/51d576c2-441f-4f60-9f0c-6fa5c2135a82.png",
                "base64": ""
            },
            "geometry": {
                "coordinates": [
                    [
                        [
                            8.38084,
                            48.99723
                        ],
                        [
                            8.38084,
                            49.02538
                        ],
                        [
                            8.42376,
                            49.02538
                        ],
                        [
                            8.42376,
                            48.99723
                        ],
                        [
                            8.38084,
                            48.99723
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "type": "Feature"
        }
    ],
    "bbox": [
        8.38084,
        48.99723,
        8.42376,
        49.02538
    ],
    "type": "FeatureCollection"
}