Render - Get Map Static Image

Service:

Maps

API Version:

2022-08-01

Se usa para representar una imagen rectangular definida por el usuario que contiene una sección de mapa mediante un nivel de zoom comprendido entre 0 y 20.

El intervalo de resolución admitido para la imagen de mapa es de 1x1 a 8192x8192. Si decide cuándo usar el servicio de imágenes estáticas sobre el servicio de mosaico de mapa, puede considerar cómo desea interactuar con el mapa representado. Si el contenido del mapa será relativamente invariable, un mapa estático es una buena opción. Si desea admitir una gran cantidad de zoom, movimiento panorámico y cambio del contenido del mapa, el servicio de mosaico de mapa sería una mejor opción.

El servicio también proporciona funcionalidad de composición de imágenes para recuperar una imagen estática con datos adicionales, como; marcadores y superposiciones de geometría con las siguientes funcionalidades.

• Especificar varios estilos de marcadores
• Representar tipos de geometría de círculo, polilínea y polígono.

Consulte Guía paso a paso para obtener ejemplos detallados.

Nota : El parámetro center o bbox debe proporcionarse a la API.

Los intervalos Lat y Lon admitidos al usar el parámetro bbox son los siguientes:

Nivel de zoom	Max Lon Range	Max Lat Range
0	360.0	170.0
1	360.0	170.0
2	360.0	170.0
3	360.0	170.0
4	360.0	170.0
5	180.0	85,0
6	90.0	42,5
7	45,0	21.25
8	22.5	10.625
9	11,25	5.3125
10	5.625	2.62625
11	2.8125	1.328125
12	1.40625	0.6640625
13	0.703125	0.33203125
14	0.3515625	0.166015625
15	0.17578125	0.0830078125
16	0.087890625	0.0415039063
17	0.0439453125	0.0207519531
18	0.0219726563	0.0103759766
19	0.0109863281	0.0051879883
20	0.0054931641	0.0025939941

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01

With optional parameters:

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer={layer}&style={style}&zoom={zoom}&center={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	RasterTileFormat	Formato deseado de la respuesta. Valor posible: png.
api-version	query	True	string	Número de versión de la API de Azure Maps. La versión actual es 2022-08-01
bbox	query		number[]	Rectángulo de selección. Proyección usada: EPSG:3857. Formato: 'minLon, minLat, maxLon, maxLat'. Nota: bbox o center son parámetros obligatorios. Son mutuamente excluyentes. No debe usarse con alto o ancho. Los intervalos máximos permitidos para Lat y Lon se definen para cada nivel de zoom de la tabla en la parte superior de esta página.
center	query		number[]	Coordenadas del punto central. Formato: 'lon,lat'. Proyección usada EPSG:3857. Intervalo de longitud: -180 a 180. Intervalo de latitud: -85 a 85. Nota: Los parámetros de center o bbox son obligatorios. Son mutuamente excluyentes.
height	query		integer int32	Alto de la imagen resultante en píxeles. El intervalo es de 1 a 8192. El valor predeterminado es 512. No se debe usar con bbox.
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.
layer	query		StaticMapLayer	Capa de mapa solicitada. Si la capa está establecida en etiquetas o híbridas, el formato debe ser png.
path	query		string[]	Estilo y ubicaciones de ruta de acceso. Use este parámetro para agregar opcionalmente líneas, polígonos o círculos a la imagen. El estilo de ruta de acceso describe la apariencia de la línea y el relleno. (Asegúrese de codificar correctamente los valores de este parámetro, ya que contendrá caracteres reservados, como canalizaciones y puntuación). El parámetro Path se admite en Azure Maps SKU de cuenta a partir de S1. Varias instancias del parámetro path permiten especificar varias geometrías con sus estilos. El número de parámetros por solicitud está limitado a 10 y el número de ubicaciones está limitado a 100 por ruta de acceso. Para representar un círculo con radio de 100 metros y punto central en latitud 45°N y longitud 122°W con el estilo predeterminado, agregue el parámetro querystring. path=ra100||-122 45 Tenga en cuenta que la longitud viene antes de la latitud. Después de codificar la dirección URL, tendrá este aspecto. path=ra100%7C%7C-122+45 Todos los ejemplos aquí muestran el parámetro path sin codificación url, para mayor claridad. Para representar una línea, separe cada ubicación con un carácter de barra vertical. Por ejemplo, use path=||-122 45|-119.5 43.2|-121.67 47.12 Para representar un polígono, la última ubicación debe ser igual a la ubicación inicial. Por ejemplo, use path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45 Los valores de longitud y latitud para ubicaciones de líneas y polígonos pueden estar en el intervalo de -360 a 360 para permitir la representación de geometrías que cruzan el anti meridiano. Modificadores de estilo Puede modificar la apariencia de la ruta de acceso agregando modificadores de estilo. Estos se agregan antes de las ubicaciones. Cada uno de los modificadores de estilo tiene un nombre de dos letras. Estos nombres abreviados se usan para ayudar a reducir la longitud de la dirección URL. Para cambiar el color del contorno, use el modificador de estilo 'lc' y especifique el color con el formato de color RGB HTML/CSS, que es un número hexadecimal de seis dígitos (no se admite el formulario de tres dígitos). Por ejemplo, para usar un color rosa profundo que especificaría como #FF1493 en CSS, use path=lcFF1493||-122 45|-119.5 43.2 Se pueden combinar varios modificadores de estilo para crear un estilo visual más complejo. lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6 Resumen del modificador de estilo Modificador Descripción Intervalo Lc Color de línea 000000 a FFFFFF fc Fill color (Color de relleno) 000000 a FFFFFF la Alfa de línea (opacidad) De 0 a 1 fa Relleno alfa (opacidad) De 0 a 1 Lw Ancho de línea Mayor que 0 Ra Radio de círculo (metros) Mayor que 0
pins	query		string[]	Estilo y instancias de marcadores. Use este parámetro para agregar opcionalmente marcadores a la imagen. El estilo de chincheta describe la apariencia de las marcadores y las instancias especifican las coordenadas de los marcadores y las etiquetas opcionales para cada patilla. (Asegúrese de codificar correctamente los valores de este parámetro, ya que contendrá caracteres reservados, como canalizaciones y puntuación). La SKU de la cuenta de Azure Maps solo admite una única instancia del parámetro pins. Otras SKU permiten que varias instancias del parámetro pins especifiquen varios estilos de patilla. Para representar una chincheta en la latitud 45°N y longitud 122°W con el estilo de marcador integrado predeterminado, agregue el parámetro querystring. pins=default||-122 45 Tenga en cuenta que la longitud viene antes de la latitud. Después de codificar la dirección URL, tendrá este aspecto pins=default%7C%7C-122+45 Todos los ejemplos aquí muestran el parámetro pins sin codificación de direcciones URL, para mayor claridad. Para representar un pin en varias ubicaciones, separe cada ubicación con un carácter de canalización. Por ejemplo, use pins=default||-122 45|-119.5 43.2|-121.67 47.12 La SKU de la cuenta de Azure Maps S0 solo permite cinco marcadores. Otras SKU de cuenta no tienen esta limitación. Modificadores de estilo Puede aplicar modificadores de estilo para modificar la apariencia de los marcadores. Se agregan después del estilo, pero antes de las ubicaciones y las etiquetas. Cada uno de los modificadores de estilo tiene un nombre de dos letras. Estos nombres abreviados se usan para ayudar a reducir la longitud de la dirección URL. Para cambiar el color de la chincheta, use el modificador de estilo 'co' y especifique el color con el formato de color RGB HTML/CSS, que es un número hexadecimal de seis dígitos (no se admite el formulario de tres dígitos). Por ejemplo, para usar un color rosa profundo que especificaría como #FF1493 en CSS, use pins=default|coFF1493||-122 45 Etiquetas de marcadores Para agregar una etiqueta a las patillas, coloque la etiqueta entre comillas simples justo antes de las coordenadas. Por ejemplo, para etiquetar tres patillas con los valores "1", "2" y "3", use pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12 Hay un estilo de marcadores integrado denominado "none" que no muestra una imagen de marcadores. Puede usar esto si desea mostrar etiquetas sin ninguna imagen de anclaje. Por ejemplo, pins=none||'A'-122 45|'B'-119.5 43.2 Para cambiar el color de las etiquetas de marcadores, use el modificador de estilo de color de etiqueta "lc". Por ejemplo, para usar marcadores rosas con etiquetas negras, use pins=default|coFF1493|lc000000||-122 45 Para cambiar el tamaño de las etiquetas, use el modificador de estilo de tamaño de etiqueta "ls". El tamaño de la etiqueta representa el alto aproximado del texto de la etiqueta en píxeles. Por ejemplo, para aumentar el tamaño de la etiqueta a 12, use pins=default|ls12||'A'-122 45|'B'-119 43 Las etiquetas se centran en el marcador "delimitador de etiquetas". La ubicación de anclaje está predefinida para marcadores integrados y se encuentra en el centro superior de marcadores personalizados (consulte a continuación). Para invalidar el delimitador de etiqueta, use el modificador de estilo "la" y proporcione coordenadas de píxeles X e Y para el delimitador. Estas coordenadas son relativas a la esquina superior izquierda de la imagen de la chincheta. Los valores X positivos mueven el delimitador hacia la derecha y los valores Y positivos mueven el delimitador hacia abajo. Por ejemplo, para colocar el delimitador de etiqueta de 10 píxeles a la derecha y 4 píxeles por encima de la esquina superior izquierda de la imagen de la chincheta, use pins=default|la10 -4||'A'-122 45|'B'-119 43 Marcadores personalizados Para usar una imagen de chincheta personalizada, use la palabra "custom" como nombre del estilo de anclaje y, a continuación, especifique una dirección URL después de la ubicación y la información de etiqueta. Use dos caracteres de canalización para indicar que ha terminado de especificar ubicaciones y está iniciando la dirección URL. Por ejemplo, pins=custom||-122 45||http://contoso.com/pushpins/red.png Después de la codificación de direcciones URL, sería similar a pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png De forma predeterminada, las imágenes de marcadores personalizadas se dibujan centradas en las coordenadas del pin. Esto normalmente no es ideal, ya que oculta la ubicación que está intentando resaltar. Para invalidar la ubicación de anclaje de la imagen de anclaje, use el modificador de estilo 'an'. Usa el mismo formato que el modificador de estilo de anclaje de etiqueta 'la'. Por ejemplo, si la imagen de anclaje personalizada tiene la punta del pin en la esquina superior izquierda de la imagen, puede establecer el delimitador en ese punto mediante pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png Nota: Si usa el modificador de color 'co' con una imagen de marcadores personalizada, el color especificado reemplazará los canales RGB de los píxeles de la imagen, pero dejará el canal alfa (opacidad) sin cambios. Normalmente, esto solo se haría con una imagen personalizada de color sólido. Escala, rotación y opacidad Puede aumentar o reducir el tamaño de los marcadores y sus etiquetas con el modificador de estilo de escala "sc". Debe ser un valor mayor que cero. Un valor de 1 es la escala estándar. Los valores mayores que 1 aumentarán el tamaño de los marcadores, mientras que los valores menores que 1 reducirán su tamaño. Por ejemplo, para dibujar los marcadores un 50 % más grandes que lo normal, use pins=default|sc1.5||-122 45 Puede girar marcadores y sus etiquetas mediante el modificador de estilo de rotación "ro". Se trata de una serie de grados de rotación en el sentido de las agujas del reloj. Use un número negativo para girar en sentido contrario a las agujas del reloj. Por ejemplo, para girar las marcadores de 90 grados en el sentido de las agujas del reloj y duplicar su tamaño, use pins=default|ro90|sc2||-122 45 Puede hacer que las marcadores y sus etiquetas sean parcialmente transparentes especificando el modificador de estilo alfa "al". Se trata de un número comprendido entre 0 y 1 que indica la opacidad de los marcadores. Cero hace que sean completamente transparentes (y no visibles) y 1 los hace completamente opacos (que es el valor predeterminado). Por ejemplo, para crear marcadores y sus etiquetas solo un 67 % opaco, use pins=default|al.67||-122 45 Resumen del modificador de estilo Modificador Descripción Intervalo al Alfa (opacidad) De 0 a 1 an Anclaje anclar * co Color de patilla 000000 a FFFFFF la Delimitador de etiquetas * Lc Color de etiqueta 000000 a FFFFFF ls Tamaño de etiqueta Mayor que 0 ro Rotación -360 a 360 Sc Escala Mayor que 0 Las coordenadas X e Y pueden estar en cualquier lugar dentro de la imagen de anclaje o un margen alrededor de ella. El tamaño del margen es el mínimo del ancho y alto del pin.
style	query		MapImageStyle	Estilo de mapa que se va a devolver. Los valores posibles son main y dark.
view	query		LocalizedMapView	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 ver las vistas disponibles.
width	query		integer int32	Ancho de la imagen resultante en píxeles. El intervalo es de 1 a 8192. El valor predeterminado es 512. No se debe usar con bbox.
zoom	query		integer int32	Nivel de zoom deseado del mapa. El valor de zoom debe estar en el intervalo: 0-20 (ambos incluidos). El valor predeterminado es 12. Consulte Niveles de zoom y cuadrícula de mosaico para obtener más información.

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 Obtener imagen estática de mapa. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers 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 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 Static Image Request

Sample Request

HTTP

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer=basic&style=main&zoom=2&bbox=1.355233,42.982261,24.980233,56.526017

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{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 "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.
MapImageStyle	Estilo de mapa que se va a devolver. Los valores posibles son main y dark.
RasterTileFormat	Formato deseado de la respuesta. Valor posible: png.
StaticMapLayer	Capa de mapa solicitada. Si la capa está establecida en etiquetas o híbridas, el formato debe ser png.

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 "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.

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)

MapImageStyle

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

Nombre	Tipo	Description
dark	string	Versión gris oscura del estilo principal de Azure Maps
main	string	Azure Maps estilo principal

RasterTileFormat

Formato deseado de la respuesta. Valor posible: png.

Nombre	Tipo	Description
png	string	Imagen en formato png. Admite los niveles de zoom del 0 al 18.

StaticMapLayer

Capa de mapa solicitada. Si la capa está establecida en etiquetas o híbridas, el formato debe ser png.

Nombre	Tipo	Description
basic	string	Devuelve una imagen que contiene todas las características del mapa, incluidos los polígonos, los bordes, las carreteras y las etiquetas.
hybrid	string	Devuelve una imagen 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 una imagen de solo la información de etiqueta del mapa.