Render - Get Map Tile

Serviço:

Maps

Versão da API:

2024-04-01

Utilize para pedir mosaicos de mapa no formato de vetor ou raster.

A Get Map Tiles API num pedido HTTP GET que permite que os utilizadores peçam mosaicos de mapa em formatos de vetor ou raster normalmente para serem integrados num controlo de mapa ou SDK. Alguns mosaicos de exemplo que podem ser pedidos são os mosaicos de estrada do Azure Maps, os mosaicos do Radar meteorológico em tempo real ou os mosaicos de mapa criados com o Criador do Azure Maps. Por predefinição, o Azure Maps utiliza mosaicos de vetor para o respetivo controlo de mapa Web (SDK Web) e SDK Android.

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

Com parâmetros opcionais:

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}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	Número da versão da API do Azure Maps. A versão atual é 2024-04-01.
tilesetId	query	True	TilesetID	Um conjunto de mosaicos é uma coleção de dados de raster ou vetor divididos numa grelha uniforme de mosaicos quadrados em níveis de zoom predefinidos. Cada conjunto de mosaicos tem um tilesetId para utilizar ao fazer pedidos. O tilesetId para conjuntos de mosaicos criados com o Criador do Azure Maps é gerado através da API de Criação do Conjunto de Mosaicos. Os conjuntos de mosaicos prontos a utilizar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.
x	query	True	integer int32	Coordenada X do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1]. Consulte Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
y	query	True	integer int32	Coordenada Y do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1]. Consulte Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
zoom	query	True	integer int32	Nível de zoom para o mosaico pretendido. Consulte Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
language	query		string	Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.
tileSize	query		MapTileSize	O tamanho do mosaico do mapa devolvido em píxeis.
timeStamp	query		string date-time	A data e hora pretendidas do mosaico pedido. Este parâmetro tem de ser especificado no formato de data/hora padrão (por exemplo, 2019-11-14T16:03:00-08:00), conforme definido por ISO 8601. Este parâmetro só é suportado quando o parâmetro tilesetId está definido como um dos valores abaixo. microsoft.weather.infrared.main: fornecemos mosaicos até 3 horas no passado. Os mosaicos estão disponíveis em intervalos de 10 minutos. Arredondamos o valor timeStamp para o intervalo de tempo de 10 minutos mais próximo. microsoft.weather.radar.main: fornecemos mosaicos até 1,5 horas no passado e até 2 horas no futuro. Os mosaicos estão disponíveis em intervalos de 5 minutos. Arredondamos o valor timeStamp para o intervalo de tempo de 5 minutos mais próximo.
view	query		LocalizedMapView	O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através do Azure Maps. Exemplo: view=IN. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	object	O mosaico devolvido a partir de uma chamada à API bem-sucedida. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Cabeçalhos Content-Type: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Segurança

AADToken

Estes são os Fluxos Microsoft Entra OAuth 2.0 . Quando emparelhado com o controlo de acesso baseado em funções do Azure , pode ser utilizado para controlar o acesso às APIs REST do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para as APIs REST do Azure Maps.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

• Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * A utilização do SDK Web do Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

• Para obter mais informações sobre a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST do Azure Maps, onde esta chave pode ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Tipo: apiKey
Em: header

Exemplos

Successful Tile Request

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

"binary image string"

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
LocalizedMapView	O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através do Azure Maps. Exemplo: view=IN. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.
MapTileSize	O tamanho do mosaico do mapa devolvido em píxeis.
TilesetID	Um conjunto de mosaicos é uma coleção de dados de raster ou vetor divididos numa grelha uniforme de mosaicos quadrados em níveis de zoom predefinidos. Cada conjunto de mosaicos tem um tilesetId para utilizar ao fazer pedidos. O tilesetId para conjuntos de mosaicos criados com o Criador do Azure Maps é gerado através da API de Criação do Conjunto de Mosaicos. Os conjuntos de mosaicos prontos a utilizar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através do Azure Maps. Exemplo: view=IN.

Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.

Name	Tipo	Description
AE	string	Emirados Árabes Unidos (Vista Árabe)
AR	string	Argentina (Vista Argentina)
Auto	string	Devolver os dados do mapa com base no endereço IP do pedido.
BH	string	Barém (Vista Árabe)
IN	string	Índia (Vista Indiana)
IQ	string	Iraque (Vista Árabe)
JO	string	Jordânia (Vista Árabe)
KW	string	Kuwait (Vista Árabe)
LB	string	Líbano (Vista Árabe)
MA	string	Marrocos (Vista Marroquina)
OM	string	Omã (Vista Árabe)
PK	string	Paquistão (Vista Paquistanesa)
PS	string	Autoridade Palestiniana (Vista Árabe)
QA	string	Qatar (Vista Árabe)
SA	string	Arábia Saudita (Vista Árabe)
SY	string	Síria (Vista Árabe)
Unified	string	Vista Unificada (Outros)
YE	string	Iémen (Vista Árabe)

MapTileSize

O tamanho do mosaico do mapa devolvido em píxeis.

Name	Tipo	Description
256	string	Devolver um mosaico de 256 por 256 píxeis.
512	string	Devolver um mosaico de 512 por 512 píxeis.

TilesetID

Um conjunto de mosaicos é uma coleção de dados de raster ou vetor divididos numa grelha uniforme de mosaicos quadrados em níveis de zoom predefinidos. Cada conjunto de mosaicos tem um tilesetId para utilizar ao fazer pedidos. O tilesetId para conjuntos de mosaicos criados com o Criador do Azure Maps é gerado através da API de Criação do Conjunto de Mosaicos. Os conjuntos de mosaicos prontos a utilizar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

Name	Tipo	Description
microsoft.base	string	Um mapa base é um mapa padrão que apresenta estradas, características naturais e artificiais, juntamente com as etiquetas dessas funcionalidades num mosaico de vetor. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.darkgrey	string	Todas as camadas com o nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid	string	Apresenta dados de estradas, limites e etiquetas num mosaico de vetor. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.hybrid.darkgrey	string	Dados de estradas, limites e etiquetas no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid.road	string	Dados de estradas, limites e etiquetas no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels	string	Apresenta etiquetas para estradas, características naturais e artificiais num mosaico de vetor. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.labels.darkgrey	string	Etiquetar dados no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels.road	string	Etiquetar dados no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.road	string	Todas as camadas com o nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.imagery	string	Uma combinação de imagens aéreas e satélite. Apenas disponível no SKU de preços S1. Suporta níveis de zoom de 1 a 19. Formato: raster (jpeg).
microsoft.terra.main	string	Relevo sombreado e camadas de terra. Suporta níveis de zoom de 0 a 6. Formato: raster (png).
microsoft.traffic.absolute	string	mosaicos de tráfego absoluto no vetor
microsoft.traffic.absolute.main	string	mosaicos de tráfego absoluto no raster no nosso estilo principal.
microsoft.traffic.delay	string	mosaicos de tráfego no vetor
microsoft.traffic.delay.main	string	mosaicos de tráfego no raster no nosso estilo principal
microsoft.traffic.incident	string	mosaicos de incidentes no vetor
microsoft.traffic.reduced.main	string	mosaicos de tráfego reduzido no raster no nosso estilo principal
microsoft.traffic.relative	string	mosaicos de tráfego relativo no vetor
microsoft.traffic.relative.dark	string	mosaicos de tráfego relativo no raster no nosso estilo escuro.
microsoft.traffic.relative.main	string	mosaicos de tráfego relativo no raster no nosso estilo principal.
microsoft.weather.infrared.main	string	Mosaicos de infravermelhos meteorológicos. As últimas imagens de Satélite de Infravermelhos mostram nuvens pela sua temperatura. Para obter mais informações, veja Cobertura dos serviços meteorológicos do Azure Maps. Para obter mais informações sobre os dados de satélite devolvidos, veja Serviços de meteorologia no Azure Maps. Suporta níveis de zoom de 0 a 15. Formato: raster (png).
microsoft.weather.radar.main	string	Mosaicos de radar meteorológico. As últimas imagens de radares meteorológicos, incluindo áreas de chuva, neve, gelo e condições mistas. Para obter mais informações sobre a cobertura do serviço de meteorologia do Azure Maps, veja Cobertura dos serviços meteorológicos do Azure Maps. Para obter mais informações sobre dados de Radar, veja Serviços de meteorologia no Azure Maps. Suporta níveis de zoom de 0 a 15. Formato: raster (png).