Render - Get Map Tile

Servicio:

Maps

Versión de la API:

1.0

use para obtener iconos de mapa en formato vectorial o ráster normalmente para integrarse en un nuevo control de mapa o SDK.

Nota

Retirada del servicio Render v1 de Azure Maps

El servicio Render v1 de Azure Maps ya está en desuso y se retirará el 17/9/26. Para evitar interrupciones del servicio, todas las llamadas a Render v1 API se tendrán que actualizar para usar Render v2 API antes del 17/9/26.

Captura iconos de mapa en formato vectorial o ráster normalmente para integrarse en un nuevo control de mapa o SDK. De forma predeterminada, Azure usa iconos de mapa vectorial para su control de mapa web (consulte Niveles de zoom y cuadrícula de mosaicos).

Nota: Los iconos meteorológicos solo están disponibles a través de la API Get Map Tile V2. Se recomienda empezar a usar la nueva API Get Map Tile V2.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

Con parámetros opcionales:

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	TileFormat	Formato deseado de la respuesta. Los valores posibles son png & pbf.
api-version	query	True	string	Número de versión de la API de Azure Maps.
layer	query	True	MapTileLayer	Capa de mapa solicitada. Los valores posibles son básico, híbrido, etiquetas y terra.
style	query	True	MapTileStyle	Estilo de mapa que se va a devolver. Los valores posibles son main, dark y shaded_relief.
x	query	True	integer int32	Coordenada X del icono en la cuadrícula de zoom. El valor debe estar en el intervalo [0, 2zoom -1]. 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, 2zoom -1]. 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 lenguaje 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.
tileSize	query		MapTileSize	Tamaño del icono de mapa devuelto en píxeles.
view	query		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.

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	Esta imagen se devuelve de una llamada correcta a Get Map Tile Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Encabezados Content-Type: string
Other Status Codes	ErrorResponse	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 Microsoft Entra flujos de OAuth 2.0. 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. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio 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 modelar 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 introducción a Plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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 una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido 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 rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, 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 asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Successful Tile Request

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Respuesta de muestra

status code:

200

Content-Type: image/png

"{file}"

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta 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.
MapTileLayer	Capa de mapa solicitada. Los valores posibles son básico, híbrido, etiquetas y terra.
MapTileSize	Tamaño del icono de mapa devuelto en píxeles.
MapTileStyle	Estilo de mapa que se va a devolver. Los valores posibles son main, dark y shaded_relief.
TileFormat	Formato deseado de la respuesta. Los valores posibles son png & pbf.

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	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	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)

MapTileLayer

Capa de mapa solicitada. Los valores posibles son básico, híbrido, etiquetas y terra.

Nombre	Tipo	Description
basic	string	Devuelve un icono que contiene todas las características del mapa, incluidos polígonos, bordes, carreteras y etiquetas.
hybrid	string	Devuelve un icono que contiene bordes, carreteras y etiquetas, y se puede superponer en otros iconos (como imágenes de satélite) para generar iconos híbridos.
labels	string	Devuelve un icono de solo la información de etiqueta del mapa.
terra	string	Lienzo de mapa completo con mosaicos de relieve sombreado. Se admiten los niveles de zoom 0-6 (ambos incluidos). Png es el único TileFormat compatible y solo mapTileSize disponible es 512.

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.

MapTileStyle

Estilo de mapa que se va a devolver. Los valores posibles son main, dark y shaded_relief.

Nombre	Tipo	Description
dark	string	Versión gris oscuro del estilo principal de Azure Maps. PNG es el único TileFormat compatible.
main	string	Azure Maps estilo principal
shaded_relief	string	Azure Maps estilo principal completado con relieve sombreado. Compatible con Layer terra.

TileFormat

Formato deseado de la respuesta. Los valores posibles son png & pbf.

Nombre	Tipo	Description
pbf	string	Gráfico vectorial en formato pbf. Admite los niveles de zoom de 0 a 22.
png	string	Imagen en formato png. Admite los niveles de zoom del 0 al 18.