Статичная карта
/staticmap/png — сервис, позволяющий получить изображение карты.
Запрос
Обязательные параметры запроса
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
api_key |
hex-string |
|
||
latlon |
float,float |
Широта и долгота (в градусах) геометрического центра требуемого изображения карты. Широта и долгота указывается через запятую.
|
|
|
bbox | float,float,float,float |
Область местонахождения объекта, которая описывается парой координат в порядке: lat1,lon1,lat2,lon2 Широта и долгота координат указывается через запятую. Координаты разделяются запятой |
|
Дополнительные параметры запроса
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
zoom | integer |
Уровень масштабирования в диапазоне от 0 до 17, где
|
|
|
width | integer |
Ширина изображения карты. Значение может находиться в диапазоне от 32 до 1024 пикселей (по умолчанию 512) |
|
|
height | integer |
Высота изображения карты. Значение может находиться в диапазоне от 32 до 1024 пикселей (по умолчанию 512) |
|
|
pins |
string |
Параметры, которые определяют расположение и тип булавок, добавляемых на карту. Параметры должны передаваться в формате: lat1,lon1,icon1|lat2,lon2,icon2|..., где
Форматы доступных булавок представлены в коллекции булавок |
|
|
style | string |
Параметр выбора стиля отображения карты. По умолчанию используется стиль: main |
|
|
padding | integer |
Параметр смещения атрибутов карты. Смещение определяется в пикселях и равно расстоянию от правого края надписи до правого края атрибутов. Ограничения: значение может находиться в диапазоне от 5 до width/2 пикселей (по умолчанию 5) |
|
|
scale | integer |
Параметр масштабирования изображения. Возможны значения 1 или 2 (по умолчанию 1). Если scale=2, то размеры итогового изображения будут в 2 раза больше за счёт большей плотности пикселей. Например, при запросе width=200&height=200&scale=2 результирующее изображение будет размером 400x400 пикселей, но выглядеть будет, как при запросе width=200&height=200, а не width=400&height=400:
width=200&height=200
width=200&height=200&scale=2
width=400&height=400 |
|
Запрос (POST)
Обязательные параметры запроса (GET)
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
api_key |
hex-string |
|
Обязательные параметры запроса (POST)
Параметры принимаются в теле запроса в составе JSON-объекта
Имя поля
|
Формат
|
Описание
|
Пример
| |
---|---|---|---|---|
coord |
coord — JSON объект с float полями «lat» и «lon» |
Широта и долгота (в градусах) геометрического центра требуемого изображения карты.
|
|
|
bbox | JSON массив из 2-х элементов |
Область местонахождения объекта, которая описывается парой координат. |
|
Дополнительные параметры запроса
Имя поля | Формат | Описание | Пример | |
---|---|---|---|---|
Имя поля | Формат | Описание | Пример | |
zoom | integer |
Уровень масштабирования в диапазоне от 0 до 17, где
|
|
|
width | integer |
Ширина изображения карты. Значение может находиться в диапазоне от 32 до 1024 пикселей (по умолчанию 512) |
|
|
height | integer |
Высота изображения карты. Значение может находиться в диапазоне от 32 до 1024 пикселей (по умолчанию 512) |
|
|
pins |
JSON массив объектов |
Описание булавок, добавляемых на карту |
|
|
coord |
JSON массив |
Определяет расположение булавок добавляемых на карту |
||
icon |
JSON массив |
Описание визуального представления булавок добавляемых на карту |
||
symbol |
string |
Поле «symbol» содержит формат визуального представления булавки Форматы доступных булавок представлены в коллекции булавок |
||
base64 |
string |
Изображение булавки в формате PNG в base64-закодированном виде (не больше 250 тысяч символов) |
||
url |
string |
URL изображения PNG. Длина URL не должна превышать 1000 символов, размер изображения не должен превышать 512 КБ. Поддерживается только транспорт HTTPS, передача без сжатия и редиректов. |
||
features | GeoJSON объект |
GeoJSON, описывающий геометрию для отображения на верхнем слое карты. Свойство properties является опциональным. |
|
|
features-style | JSON объект |
Настройка визуального отображения GeoJSON, переданного в features. Отображение точек, линий и многоугольников настраивается отдельно:
|
|
|
style | string |
Параметр выбора стиля отображения карты. По умолчанию используется стиль «main» |
|
|
padding | integer |
Параметр смещения атрибутов карты. Смещение определяется в пикселях и равно расстоянию от правого края надписи до правого края атрибутов. Ограничения: значение может находиться в диапазоне от 5 до width/2 пикселей (по умолчанию 5) |
|
|
scale | integer |
Параметр масштабирования изображения. Возможны значения 1 или 2 (по умолчанию 1). |
|
Ответ
В ответ вы получите изображение части карты, соответствующей параметрам, указанным в запросе.
Пример
Запрос (GET)
https://geo.rustore.ru/api/staticmap/png?api_key=<YOUR_API_KEY>&latlon=55.727,37.59&style=main&zoom=10&width=1024&height=512&padding=5&pins=55.73,37.59,rustore-corp_photo|55.76,37.59,green_star|55.745,37.67,rustore-electric_a |
Запрос (POST)
{ "width" : 660 , "height" : 600 , "bbox" : [{ "lat" : 55.71 , "lon" : 37.65 }, { "lat" : 55.8 , "lon" : 37.6535 } ], "padding" : 200 , "scale" : 1 , "features" : {}, "coord" : { "lat" : 55.7505 , "lon" : 37.6165 }, "pins" : [ { "coord" : { "lat" : 55.73 , "lon" : 37.59 }, "icon" : { "symbol" : "rustore-corp_photo" } }, { "coord" : { "lat" : 55.76 , "lon" : 37.59 }, "icon" : { "symbol" : "green_star" } }, { "coord" : { "lat" : 55.745 , "lon" : 37.67 }, "icon" : { "symbol" : "rustore-electric_a" } } ], "zoom" : 11 , "style" : "main" } |
Ответ