/staticmap/png — сервис позволяющий получить изображение карты.
| Имя поля | Формат | Описание | Пример |
|---|---|---|---|
api_key |
hex-string | Ключ доступа к сервисам | fa749bace6d8a3b1.... |
latlon |
float,float | Широта и долгота (в градусах) геометрического центра требуемого изображения карты. Широта и долгота указывается через запятую. При указании bbox в запросе значения, указанные в latlon, игнорируются. |
latlon=55.727,37.59 |
bbox |
float,float,float,float | Область местонахождения объекта, которая описывается парой координат в порядке: lat1,lon1,lat2,lon2. Широта и долгота координат указывается через запятую. |
bbox=55.7,37.65,55.8,37.66 |
| Имя поля | Формат | Описание | По умолчанию | Пример |
|---|---|---|---|---|
zoom |
integer | Уровень масштабирования в диапазоне от 0 до 17, где 0 — соответствует уровню обзора мира, 17 — соответствует уровню обзора здания. |
0 |
zoom=13 |
width |
integer | Ширина изображения карты. Значение может находиться в диапазоне от 32 до 1024 пикселей. | 512 |
width=640 |
height |
integer | Высота изображения карты. Значение может находиться в диапазоне от 32 до 1024 пикселей. | 512 |
height=480 |
pins |
string | Параметры, которые определяют расположение и тип булавок, добавляемых на карту. Формат: lat1,lon1,icon1\|lat2,lon2,icon2\|..., где lat — широта, lon — долгота, icon — формат булавки. Форматы доступных булавок представлены на странице: Коллекция булавок. |
— | pins=55.7505,37.6165,blue_star\|60.6543,38.1255,red_camera |
style |
string | Параметр выбора стиля отображения карты. | main |
style=light |
padding |
integer | Параметр смещения атрибутов карты. Смещение определяется в пикселях и равно расстоянию от правого края надписи до правого края атрибутов. Значение может находиться в диапазоне от 5 до width/2 пикселей. |
5 |
padding=40 |
scale |
integer | Параметр масштабирования изображения. Возможны значения 1 или 2. Если scale=2, то размеры итогового изображения будут в 2 раза больше за счёт большей плотности пикселей. Например, при запросе width=200&height=200&scale=2 результирующее изображение будет размером 400×400 пикселей, но выглядеть будет как при запросе width=200&height=200, а не width=400&height=400. |
1 |
scale=2 |
| Имя поля | Формат | Описание | Пример |
|---|---|---|---|
api_key |
hex-string | Ключ доступа к сервисам | fa749bace6d8a3b1.... |
Параметры принимаются в теле запроса в составе JSON-объекта.
| Имя поля | Формат | Описание | Пример |
|---|---|---|---|
coord |
JSON-объект | Широта и долгота (в градусах) геометрического центра требуемого изображения карты. JSON-объект с полями lat и lon. При указании bbox значения, указанные в coord, игнорируются. |
{"lat": 55.727, "lon": 37.59} |
bbox |
JSON-массив из 2 элементов | Область местонахождения объекта, которая описывается парой координат. | [{"lat": 55.71, "lon": 37.65}, {"lat": 55.8, "lon": 37.6535}] |
| Имя поля | Формат | Описание | По умолчанию | Пример |
|---|---|---|---|---|
zoom |
integer | Уровень масштабирования в диапазоне от 0 до 17, где 0 — уровень обзора мира, 17 — уровень обзора здания. |
0 |
"zoom": 13 |
width |
integer | Ширина изображения карты. Диапазон: от 32 до 1024 пикселей. | 512 |
"width": 640 |
height |
integer | Высота изображения карты. Диапазон: от 32 до 1024 пикселей. | 512 |
"height": 480 |
pins |
JSON-массив объектов | Описание булавок, добавляемых на карту. Каждый объект содержит поля coord и icon. |
— | см. ниже |
coord |
JSON-массив | Определяет расположение булавок, добавляемых на карту. | — | |
icon |
JSON-объект | Описание визуального представления булавок. Содержит одно из полей: symbol, base64 или url. |
— | |
symbol |
string | Формат визуального представления булавки. Форматы доступных булавок представлены на странице: Коллекция булавок. | — | "symbol": "mail-corp_photo" |
base64 |
string | Изображение булавки в формате PNG в base64-закодированном виде. Не более 250 тысяч символов. | — | "base64": "iVBORw0KGgoA..." |
url |
string | URL изображения PNG. Длина URL не должна превышать 1000 символов, размер изображения — 512 КБ. Поддерживается только транспорт HTTPS, передача без сжатия и редиректов. | — | "url": "https://example.com/pin.png" |
features |
GeoJSON-объект | GeoJSON, описывающий геометрию для отображения на верхнем слое карты. Свойство properties является опциональным. Поддерживаются типы: Point, LineString, Polygon. |
— | см. ниже |
features-style |
JSON-объект | Настройка визуального отображения GeoJSON, переданного в features. Содержит секции point, line, polygon. |
— | см. ниже |
style |
string | Параметр выбора стиля отображения карты. | main |
"style": "light" |
padding |
integer | Параметр смещения атрибутов карты в пикселях. Диапазон: от 5 до width/2. |
5 |
"padding": 40 |
scale |
integer | Параметр масштабирования изображения. Возможны значения 1 или 2. |
1 |
"scale": 2 |
features-style| Секция | Поле | Описание |
|---|---|---|
point |
circle-color |
Цвет круга |
point |
circle-opacity |
Прозрачность круга |
point |
circle-radius |
Радиус круга в пикселях |
line |
line-width |
Толщина линии в пикселях |
line |
line-color |
Цвет линии |
line |
line-opacity |
Прозрачность линии |
polygon |
fill-color |
Цвет заливки |
polygon |
fill-opacity |
Прозрачность заливки |
В ответ возвращается изображение части карты, соответствующей параметрам, указанным в запросе.
/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,mail-corp_photo|55.76,37.59,green_star|55.745,37.67,mail-electric_a
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"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": "mail-corp_photo"}
},
{
"coord": {"lat": 55.76, "lon": 37.59},
"icon": {"symbol": "green_star"}
},
{
"coord": {"lat": 55.745, "lon": 37.67},
"icon": {"symbol": "mail-electric_a"}
}
],
"zoom": 11,
"style": "main"
}' \
"/api/staticmap/png?api_key=your_api_key"
Пример с пользовательскими булавками через base64 и url:
{
"pins": [
{
"coord": {"lat": 55.73, "lon": 37.59},
"icon": {"symbol": "mail-corp_photo"}
},
{
"coord": {"lat": 55.76, "lon": 37.59},
"icon": {"base64": "iVBORw0KGgoA..."}
},
{
"coord": {"lat": 55.745, "lon": 37.67},
"icon": {"url": "https://example.com/pin.png"}
}
]
}
Пример с GeoJSON-геометрией и стилями:
{
"features": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [37.6165, 55.7505]
},
"properties": {"title": "points"}
},
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [
[37.6163, 55.7503],
[37.6164, 55.7504],
[37.6165, 55.7505],
[37.6166, 55.7506]
]
},
"properties": {"title": "line"}
},
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[[37.6395, 55.73], [37.6066, 55.73], [37.6066, 55.751], [37.6395, 55.751], [37.6395, 55.73]],
[[37.6345, 55.735], [37.6345, 55.746], [37.6116, 55.746], [37.6116, 55.735], [37.6345, 55.735]]
]
},
"properties": {"title": "polygon"}
}
]
},
"features-style": {
"point": {
"circle-color": "#ffffff",
"circle-opacity": 0.8,
"circle-radius": 4.0
},
"line": {
"line-color": "#2688eb",
"line-width": 2.0
},
"polygon": {
"fill-color": "#2688eb",
"fill-opacity": 0.5
}
}
}
В ответ возвращается бинарное изображение карты в формате PNG.