Render - Get Map Tile
Используйте для запроса плиток карты в векторном или растровом формате.
**
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=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-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.08.2022. |
tileset
|
query | True |
Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base. |
|
x
|
query | True |
integer int32 |
Координата X плитки на сетке масштабирования. Значение должно находиться в диапазоне [0, 2 Дополнительные сведения см. в разделе Уровни масштабирования и сетка плиток . |
y
|
query | True |
integer int32 |
Координата Y плитки на сетке масштабирования. Значение должно находиться в диапазоне [0, 2 Дополнительные сведения см. в разделе Уровни масштабирования и сетка плиток . |
zoom
|
query | True |
integer int32 |
Уровень масштаба для нужной плитки. Дополнительные сведения см. в разделе Уровни масштабирования и сетка плиток . |
language
|
query |
string |
Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки . |
|
tile
|
query |
Размер возвращаемой плитки карты в пикселях. |
||
time
|
query |
string date-time |
Желаемая дата и время запрошенной плитки. Этот параметр должен быть указан в стандартном формате даты и времени (например, 2019-11-14T16:03:00-08:00), как определено в ISO 8601. Этот параметр поддерживается только в том случае, если для параметра tilesetId задано одно из указанных ниже значений.
|
|
view
|
query |
Параметр View (также называемый параметром user region) позволяет отобразить правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию для параметра View задано значение Unified, даже если вы не определили его в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное определение параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которых доступны карты, изображения и другие данные, а также содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления . |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи 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" Headers Content-Type: string |
Other Status Codes |
Произошла непредвиденная ошибка. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
Безопасность
AADToken
Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.
Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.
Примечания
- Это определение безопасности требует использования заголовка
x-ms-client-id
, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.
объект Authorization URL
предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
* Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
* Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.
- Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который подготавливается при создании ресурса Azure Maps с помощью плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов AZURE SDK или REST API.
С помощью этого ключа любое приложение авторизовано для доступа ко всем REST API. Другими словами, в настоящее время они могут рассматриваться как master ключи к учетной записи, для которой они выдаются.
Для общедоступных приложений мы рекомендуем использовать межсерверный доступ Azure Maps REST API, где этот ключ можно безопасно хранить.
Type:
apiKey
In:
header
SAS Token
Этот маркер подписанного URL-адреса создается из операции List SAS в ресурсе Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
С помощью этого маркера любое приложение авторизовано для доступа с помощью элементов управления доступом на основе ролей Azure и точного контроля срока действия, скорости и регионов использования конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи сопоставления , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Type:
apiKey
In:
header
Примеры
Successful Tile Request
Sample Request
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Sample Response
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Определения
Имя | Описание |
---|---|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Localized |
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которой доступны карты, изображения и другие данные и содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления. |
Map |
Размер возвращаемой плитки карты в пикселях. |
TilesetID |
Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Готовые к использованию наборы плиток, предоставляемые Azure Maps, перечислены ниже. Например, microsoft.base. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
LocalizedMapView
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр 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 х 256 пикселей. |
512 |
string |
Возвращает плитку 512 на 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 |
Данные дороги, границы и метки в нашем main стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png). |
microsoft.base.labels |
string |
Отображает метки для дорог, естественных и искусственных признаков в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf). |
microsoft.base.labels.darkgrey |
string |
Пометка данных в нашем темно-сером стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png). |
microsoft.base.labels.road |
string |
Пометка данных в main стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png). |
microsoft.base.road |
string |
Все слои с нашим main стилем. Поддерживает уровни масштабирования от 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 |
плитки абсолютного трафика в растровом формате в нашем стиле main. |
microsoft.traffic.delay |
string |
плитки трафика в векторе |
microsoft.traffic.delay.main |
string |
растровые плитки трафика в стиле main |
microsoft.traffic.incident |
string |
плитки инцидентов в векторе |
microsoft.traffic.reduced.main |
string |
уменьшенный трафик плитки в растре в нашем стиле main |
microsoft.traffic.relative |
string |
плитки относительного трафика в векторе |
microsoft.traffic.relative.dark |
string |
плитки относительного трафика в растре в нашем темном стиле. |
microsoft.traffic.relative.main |
string |
плитки относительного трафика в растре в нашем стиле main. |
microsoft.weather.infrared.main |
string |
Плитки в инфракрасном диапазоне погоды. Последние инфракрасные спутниковые снимки показывают облака по их температуре. См. сведения о покрытии для службы погоды Azure Maps. Дополнительные сведения о возвращаемых спутниковых данных см. в разделе Основные понятия погоды. Поддерживает уровни масштабирования от 0 до 15. Формат: растровый (png). |
microsoft.weather.radar.main |
string |
Плитки метеорологического радара. Последние метеорологические радиолокационные изображения, включая области дождя, снега, льда и смешанных условий. См. сведения о покрытии для службы погоды Azure Maps. Дополнительные сведения об радиолокационных данных см. в статье Основные понятия погоды. Поддерживает уровни масштабирования от 0 до 15. Формат: растровый (png). |