Render - Get Map Tile
Use para solicitar iconos de mapa en formato vectorial o ráster.
**
La Get Map Tiles
API es una solicitud HTTP GET
que permite a los usuarios solicitar iconos de mapa en formatos vectoriales o ráster, normalmente para integrarse en un control de mapa o sdk. Algunos iconos de ejemplo que se pueden solicitar son Azure Maps mosaicos de carretera, mosaicos weather radar en tiempo real o iconos de mapa creados con Azure Maps Creator. De forma predeterminada, Azure Maps usa iconos vectoriales para su control de mapa web (SDK web) y Android SDK.
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}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. La versión actual es 2022-08-01 |
tileset
|
query | True |
Un conjunto de mosaicos es una colección de datos de trama o vector divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId que se usará al realizar solicitudes. El tilesetId de los conjuntos de iconos creados con Azure Maps Creator se generan a través de la API De creación del conjunto de mosaicos. A continuación se enumeran los conjuntos de iconos listos para usar proporcionados por Azure Maps. Por ejemplo, microsoft.base. |
|
x
|
query | True |
integer int32 |
Coordenada X del icono en la cuadrícula de zoom. El valor debe estar en el intervalo [0, 2 Consulte Niveles de zoom y cuadrícula de mosaico para obtener más información. |
y
|
query | True |
integer int32 |
Coordenada Y del icono en la cuadrícula de zoom. El valor debe estar en el intervalo [0, 2 Consulte Niveles de zoom y cuadrícula de mosaico para obtener más información. |
zoom
|
query | True |
integer int32 |
Nivel de zoom para el icono deseado. Consulte Niveles de zoom y cuadrícula de mosaico para obtener más información. |
language
|
query |
string |
Idioma en el que se deben devolver los resultados de búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte Idiomas admitidos para obtener más información. |
|
tile
|
query |
Tamaño del icono de mapa devuelto en píxeles. |
||
time
|
query |
string date-time |
Fecha y hora deseadas del icono solicitado. Este parámetro debe especificarse en el formato de fecha y hora estándar (por ejemplo, 2019-11-14T16:03:00-08:00), tal y como se define en ISO 8601. Este parámetro solo se admite cuando el parámetro tilesetId se establece en uno de los valores siguientes.
|
|
view
|
query |
El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN. Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles. |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
object |
El icono devuelto desde una llamada API correcta. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string |
Other Status Codes |
Se ha producido un error inesperado. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
Seguridad
AADToken
Estos son los flujos de OAuth 2.0 de Microsoft Entra. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Notas
- Esta definición de seguridad requiere el uso del
x-ms-client-id
encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.
Authorization URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID.
* El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
* El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de Azure Maps API REST donde esta clave se puede almacenar de forma segura.
Type:
apiKey
In:
header
SAS Token
Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.
Type:
apiKey
In:
header
Ejemplos
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"
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Localized |
El parámetro View (también denominado parámetro "user region") le permite mostrar los mapas correctos para un determinado país o región para las regiones controvertidas geopolíticamente. Los distintos países o regiones tienen diferentes vistas de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unified" aunque no lo haya definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relacionadas con la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps. Ejemplo: view=IN. Consulte Vistas admitidas para obtener más información y ver las vistas disponibles. |
Map |
Tamaño del icono de mapa devuelto en píxeles. |
TilesetID |
Un conjunto de mosaicos es una colección de datos de trama o vector divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId que se usará al realizar solicitudes. El tilesetId para conjuntos de iconos creados mediante Azure Maps Creator se generan a través de la API de creación del conjunto de iconos. A continuación se enumeran los conjuntos de iconos listos para usar proporcionados por Azure Maps. Por ejemplo, microsoft.base. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Los detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
LocalizedMapView
El parámetro View (también denominado parámetro "user region") le permite mostrar los mapas correctos para un determinado país o región para las regiones controvertidas geopolíticamente. Los distintos países o regiones tienen diferentes vistas de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unified" aunque no lo haya definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relacionadas con la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps. Ejemplo: view=IN.
Consulte Vistas admitidas para obtener más información y ver las vistas disponibles.
Nombre | Tipo | Description |
---|---|---|
AE |
string |
Emiratos Árabes Unidos (vista árabe) |
AR |
string |
Argentina (vista argentina) |
Auto |
string |
Devuelva los datos del mapa según la dirección IP de la solicitud. |
BH |
string |
Baréin (vista árabe) |
IN |
string |
India (vista india) |
IQ |
string |
Irak (vista árabe) |
JO |
string |
Jordania (vista árabe) |
KW |
string |
Kuwait (vista árabe) |
LB |
string |
Líbano (vista árabe) |
MA |
string |
Marruecos (vista marroquí) |
OM |
string |
Omán (vista árabe) |
PK |
string |
Pakistán (vista pakistaní) |
PS |
string |
Autoridad Nacional Palestina (vista árabe) |
QA |
string |
Catar (vista árabe) |
SA |
string |
Arabia Saudí (vista árabe) |
SY |
string |
Siria (vista árabe) |
Unified |
string |
Vista unificada (otros) |
YE |
string |
Yemen (vista árabe) |
MapTileSize
Tamaño del icono de mapa devuelto en píxeles.
Nombre | Tipo | Description |
---|---|---|
256 |
string |
Devuelve un icono de 256 por 256 píxeles. |
512 |
string |
Devuelve un icono de 512 por 512 píxeles. |
TilesetID
Un conjunto de mosaicos es una colección de datos de trama o vector divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId que se usará al realizar solicitudes. El tilesetId para conjuntos de iconos creados mediante Azure Maps Creator se generan a través de la API de creación del conjunto de iconos. A continuación se enumeran los conjuntos de iconos listos para usar proporcionados por Azure Maps. Por ejemplo, microsoft.base.
Nombre | Tipo | Description |
---|---|---|
microsoft.base |
string |
Un mapa base es un mapa estándar que muestra carreteras, características naturales y artificiales junto con las etiquetas de esas características en un icono vectorial. Admite los niveles de zoom de 0 a 22. Formato: vector (pbf). |
microsoft.base.darkgrey |
string |
Todas las capas con nuestro estilo gris oscuro. Admite los niveles de zoom de 0 a 22. Formato: ráster (png). |
microsoft.base.hybrid |
string |
Muestra los datos de carretera, límite y etiqueta en un icono vectorial. Admite los niveles de zoom de 0 a 22. Formato: vector (pbf). |
microsoft.base.hybrid.darkgrey |
string |
Datos de carretera, límite y etiqueta en nuestro estilo gris oscuro. Admite los niveles de zoom de 0 a 22. Formato: ráster (png). |
microsoft.base.hybrid.road |
string |
Datos de carretera, límite y etiqueta en nuestro estilo principal. Admite los niveles de zoom de 0 a 22. Formato: ráster (png). |
microsoft.base.labels |
string |
Muestra etiquetas para carreteras, características naturales y artificiales en un icono vectorial. Admite los niveles de zoom de 0 a 22. Formato: vector (pbf). |
microsoft.base.labels.darkgrey |
string |
Etiquete los datos en nuestro estilo gris oscuro. Admite los niveles de zoom de 0 a 22. Formato: ráster (png). |
microsoft.base.labels.road |
string |
Etiquete los datos en nuestro estilo principal. Admite los niveles de zoom de 0 a 22. Formato: ráster (png). |
microsoft.base.road |
string |
Todas las capas con nuestro estilo principal. Admite los niveles de zoom de 0 a 22. Formato: ráster (png). |
microsoft.imagery |
string |
Combinación de imágenes aéreas y satélite. Solo está disponible en la SKU de precios de S1. Admite los niveles de zoom de 1 a 19. Formato: ráster (jpeg). |
microsoft.terra.main |
string |
Relieve sombreado y capas de terra. Admite los niveles de zoom del 0 al 6. Formato: ráster (png). |
microsoft.traffic.absolute |
string |
iconos de tráfico absolutos en vector |
microsoft.traffic.absolute.main |
string |
iconos de tráfico absolutos en ráster en nuestro estilo principal. |
microsoft.traffic.delay |
string |
iconos de tráfico en vector |
microsoft.traffic.delay.main |
string |
iconos de tráfico en ráster en nuestro estilo principal |
microsoft.traffic.incident |
string |
iconos de incidentes en vector |
microsoft.traffic.reduced.main |
string |
iconos de tráfico reducidos en ráster en nuestro estilo principal |
microsoft.traffic.relative |
string |
iconos de tráfico relativos en vector |
microsoft.traffic.relative.dark |
string |
iconos de tráfico relativos en ráster en nuestro estilo oscuro. |
microsoft.traffic.relative.main |
string |
iconos de tráfico relativos en ráster en nuestro estilo principal. |
microsoft.weather.infrared.main |
string |
Mosaicos infrarrojos meteorológicos. Las últimas imágenes de infrarrojos satélite muestran nubes por su temperatura. Consulte la información de cobertura para Azure Maps servicio weather. Para obtener más información sobre los datos satélite devueltos, consulte Conceptos meteorológicos. Admite los niveles de zoom de 0 a 15. Formato: ráster (png). |
microsoft.weather.radar.main |
string |
Mosaicos meteorológicos de radar. Imágenes de radar meteorológicas más recientes, incluidas áreas de lluvia, nieve, hielo y condiciones mixtas. Consulte la información de cobertura para Azure Maps servicio weather. Para más información sobre los datos de Radar, consulte Conceptos meteorológicos. Admite los niveles de zoom de 0 a 15. Formato: ráster (png). |