Backend-Service

The backend services are independent services. This is an enterprise function of the SmartMaps. The functionality is not available in SmartMaps FREE. For the activation of a service and further questions we are at your disposal in our support area .

Static Maps REST

Create static maps to use on your website or in a mailing. Using the interface described here, you can create static maps in different formats and configurations, the following functions are available:

  • Setting different map sizes and zoom levels based on any radius
  • Choice of scale unit (meter/kilometer or yard/miles)
  • Drawing in point data and selection of different icons
  • Drawing of self-defined lines
  • Drawing in automatically geocoded addresses

Entry Points

The service is provided as a standard REST service. The following mapBy service types exist:

The map section is defined by a pair of coordinates and a radius:
https://www.yellowmap.de/api_rst/v2/geojson/mapByLocation

The map section is defined by a surrounding rectangle:
https://www.yellowmap.de/api_rst/v2/geojson/mapByRect

The map section is defined by an address to be geocoded and a radius:
https://www.yellowmap.de/api_rst/v2/geojson/mapByAddress

The map section is defined by a point cloud or a single point together with a radius:
https://www.yellowmap.de/api_rst/v2/geojson/mapByPoints

Authentication

To use the interface, you need a partner name and an access key. You get both from YellowMap. For authentication, the partner name and the security key are each passed as URL parameters. The values are always to be transmitted URL-encoded.

Authentication via API key

Parameter Description
apiKey API key – received after registration.

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

Authentication via partner name and access key

Parameter Description
systemPartner Partner name – given from YellowMap.
securityId Security key – given from YellowMap.

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

Status codes

Status code Meaning
BadRequest The format of the parameter value is not valid. Only the status code is returned without page contents.
Forbidden Access is not permitted due to security regulations.
InternalServerError Software error. In addition to the status code, an image is returned indicating the error.
MethodNotAllowed The requested product features are not available.
NotAcceptable The parameter value is invalid, for example an unsupported image format is requested.
OK  
Unauthorized The access key is wrong or invalid.

Return

Code example: Draw in static map

{
    "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"
}