Render - Get Map Tile

Служба:

Maps

Версия API:

2024-04-01

Используйте для запроса плиток карты в векторном или растровом формате.

Get Map Tiles API в HTTP-запросе GET, который позволяет пользователям запрашивать плитки карты в векторном или растровом формате, как правило, для интеграции в элемент управления картой или пакет SDK. Некоторые примеры плиток, которые можно запросить, — это плитки дорог Azure Maps, плитки Weather Radar в режиме реального времени или плитки карты, созданные с помощью Azure Maps Creator. По умолчанию Azure Maps использует векторные плитки для элемента управления веб-картой (веб-пакет SDK) и пакета SDK для Android.

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}

С использованием необязательных параметров:

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Номер версии API Azure Maps Текущая версия — 01.04.2024.
tilesetId	query	True	TilesetID	Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base.
x	query	True	integer int32	Координата X плитки на сетке масштабирования. Значение должно находиться в диапазоне [0, 2zoom -1]. Дополнительные сведения см. в разделе Уровни масштабирования и сетка плиток .
y	query	True	integer int32	Координата Y плитки на сетке масштабирования. Значение должно находиться в диапазоне [0, 2zoom -1]. Дополнительные сведения см. в разделе Уровни масштабирования и сетка плиток .
zoom	query	True	integer int32	Уровень масштаба для нужной плитки. Дополнительные сведения см. в разделе Уровни масштабирования и сетка плиток .
language	query		string	Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки .
tileSize	query		MapTileSize	Размер возвращаемой плитки карты в пикселях.
timeStamp	query		string date-time	Желаемая дата и время запрошенной плитки. Этот параметр должен быть указан в стандартном формате даты и времени (например, 2019-11-14T16:03:00-08:00), как определено в ISO 8601. Этот параметр поддерживается только в том случае, если для параметра tilesetId задано одно из указанных ниже значений. microsoft.weather.infrared.main: мы предоставляем плитки до 3 часов в прошлом. Плитки доступны через 10 минут. Мы округляем значение timeStamp до ближайшего 10-минутного интервала времени. microsoft.weather.radar.main: мы предоставляем плитки до 1,5 часа в прошлом и до 2 часов в будущем. Плитки доступны через 5 минут. Мы округляем значение timeStamp до ближайшего 5-минутного интервала времени.
view	query		LocalizedMapView	Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные и содержимое сторонних производителей, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Идентификатора Microsoft Entra. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в Azure Maps см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	object	Плитка, возвращенная в результате успешного вызова API. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Заголовки Content-Type: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0 . В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.

Примечания

• Это определение безопасности требует использования заголовка x-ms-client-id , чтобы указать, к какому ресурсу Azure Maps приложение запрашивает доступ. Его можно получить из API управления Картами.

объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов Sdk для Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

• Дополнительные сведения о платформе удостоверений Майкрософт см. в статье Обзор платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, который подготавливается при создании ресурса Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов AZURE SDK или REST API.

С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Иными словами, в настоящее время их можно рассматривать как главные ключи учетной записи, для которой они выдаются.

Для общедоступных приложений мы рекомендуем использовать межсерверный доступ к REST API Azure Maps, где этот ключ можно безопасно хранить.

Тип: apiKey
В: header

SAS Token

Это маркер подписанного URL-адреса, который создается из операции SAS list в ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.

С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Successful Tile Request

Образец запроса

HTTP

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Пример ответа

Код состояния:

200

Content-Type: application/vnd.mapbox-vector-tile

"binary image string"

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
LocalizedMapView	Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные и содержимое сторонних производителей, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .
MapTileSize	Размер возвращаемой плитки карты в пикселях.
TilesetID	Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект error.

LocalizedMapView

Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные и содержимое сторонних производителей, доступ к которому вы имеете через Azure Maps. Пример: view=IN.

Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления .

Имя	Тип	Описание
AE	string	Объединенные Арабские Эмираты (арабское представление)
AR	string	Аргентина (аргентинское представление)
Auto	string	Данные карт возвращаются с учетом IP-адреса запроса.
BH	string	Бахрейн (арабское представление)
IN	string	Индия (индийское представление)
IQ	string	Ирак (арабское представление)
JO	string	Иордан (арабское представление)
KW	string	Кувейт (арабское представление)
LB	string	Ливан (арабское представление)
MA	string	Марокко (марокканское представление)
OM	string	Оман (арабское представление)
PK	string	Пакистан (пакистанское представление)
PS	string	Палестинская Автономия (арабское представление)
QA	string	Катар (арабское представление)
SA	string	Саудовская Аравия (арабское представление)
SY	string	Сирия (арабское представление)
Unified	string	Унифицированное представление (прочие)
YE	string	Йемен (арабское представление)

MapTileSize

Размер возвращаемой плитки карты в пикселях.

Имя	Тип	Описание
256	string	Возвращает плитку 256 x 256 пикселей.
512	string	Возвращает плитку 512 x 512 пикселей.

TilesetID

Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base.

Имя	Тип	Описание
microsoft.base	string	Базовая карта — это стандартная карта, отображающая дороги, природные и искусственные признаки, а также метки для этих признаков в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf).
microsoft.base.darkgrey	string	Все слои с нашим темно-серым стилем. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.hybrid	string	Отображает данные дороги, границы и метки в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf).
microsoft.base.hybrid.darkgrey	string	Данные дорог, границ и меток в нашем темно-сером стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.hybrid.road	string	Данные дорог, границ и меток в нашем основном стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.labels	string	Отображает метки для дорог, естественных и искусственных признаков в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf).
microsoft.base.labels.darkgrey	string	Пометка данных в нашем темно-сером стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.labels.road	string	Пометка данных в основном стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.road	string	Все слои с нашим основным стилем. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.imagery	string	Сочетание спутниковых и аэроснимков. Доступно только в ценовом номере SKU S1. Поддерживает уровни масштабирования от 1 до 19. Формат: растровый (jpeg).
microsoft.terra.main	string	Затенение рельефа и слои терры. Поддерживает уровни масштаба от 0 до 6. Формат: растровый (png).
microsoft.traffic.absolute	string	плитки абсолютного трафика в векторе
microsoft.traffic.absolute.main	string	плитки абсолютного трафика в растре в нашем основном стиле.
microsoft.traffic.delay	string	плитки трафика в векторе
microsoft.traffic.delay.main	string	плитки трафика в растре в нашем основном стиле
microsoft.traffic.incident	string	плитки инцидентов в векторе
microsoft.traffic.reduced.main	string	плитки с уменьшенным трафиком в растре в нашем основном стиле
microsoft.traffic.relative	string	плитки относительного трафика в векторе
microsoft.traffic.relative.dark	string	плитки относительного трафика в растре в нашем темном стиле.
microsoft.traffic.relative.main	string	плитки относительного трафика в растре в нашем основном стиле.
microsoft.weather.infrared.main	string	Плитки с инфракрасной погодой. Последние инфракрасные спутниковые снимки показывают облака по их температуре. Дополнительные сведения см. в статье Покрытие метеорологических служб Azure Maps. Дополнительные сведения о возвращаемых спутниковых данных см. в статье Службы погоды в Azure Maps. Поддерживает уровни масштабирования от 0 до 15. Формат: растровый (png).
microsoft.weather.radar.main	string	Плитки метеорологического радара. Последние изображения метеорологических радаров, включая области дождя, снега, льда и смешанных условий. Дополнительные сведения о покрытии службы погоды Azure Maps см. в статье Покрытие метеорологических служб Azure Maps. Дополнительные сведения о данных радаров см. в статье Службы погоды в Azure Maps. Поддерживает уровни масштабирования от 0 до 15. Формат: растровый (png).