Render - Get Map Tile

Serviço:

Maps

Versão da API:

2024-04-01

Use para solicitar blocos de mapa em formato vetorial ou raster.

A Get Map Tiles API permite que os usuários solicitem blocos de mapa em formatos vetoriais ou rasterizados, normalmente para integração em um controle de mapa ou SDK. Os tipos de tiles suportados incluem Azure Maps road tiles e tiles Weather Radar em tempo real. Por defeito, o Azure Maps Web SDK usa tiles vetoriais para renderizar o seu controlo do mapa web.

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 de versão do Azure Maps API. A versão atual é 2024-04-01.
tilesetId	query	True	TilesetID	Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os tilesets prontos a usar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.
x	query	True	integer (int32)	Coordenada X do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1]. Consulte Níveis de zoom e de grade de blocos para obter detalhes.
y	query	True	integer (int32)	Coordenada Y do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1]. Consulte Níveis de zoom e de grade de blocos para obter detalhes.
zoom	query	True	integer (int32)	Nível de zoom para o bloco desejado. Consulte Níveis de zoom e de grade de blocos para obter detalhes.
language	query		string	Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte de idiomas suportados para obter detalhes.
tileSize	query		MapTileSize	O tamanho do bloco de mapa retornado em pixels.
timeStamp	query		string (date-time)	A data e hora desejadas do bloco solicitado. Este parâmetro deve ser especificado no formato padrão de data-hora (por exemplo, 2019-11-14T16:03:00-08:00), conforme definido pela ISO 8601. Este parâmetro só é suportado quando o parâmetro tilesetId é definido como um dos valores abaixo. microsoft.weather.infrared.main: fornecemos blocos de até 3 horas no passado. Os mosaicos estão disponíveis em intervalos de 10 minutos. Arredondamos o valor de timeStamp para o período de tempo de 10 minutos mais próximo. microsoft.weather.radar.main: fornecemos blocos de 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 período de tempo mais próximo de 5 minutos.
view	query		LocalizedMapView	O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro de Visualização no Azure Maps deve ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde os mapas, imagens e outros dados e conteúdos de terceiros autorizados a aceder via Azure Maps estão disponíveis. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Indica a conta destinada a ser utilizada com o modelo de segurança do Microsoft Entra ID. Este ID único para a conta Azure Maps pode ser obtido a partir da API da conta Azure Maps plano de gestão. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps.

Respostas

Name	Tipo	Description
200 OK	object	O bloco retornou de uma chamada de 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 combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode receber acesso através de um papel incorporado ou de um papel personalizado composto por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Notes

• Esta definição de segurança exige a utilização do cabeçalho x-ms-client-id para indicar a que Azure Maps recurso a aplicação está a pedir acesso. Isso pode ser adquirido na API de gerenciamento do Maps.

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

• Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade 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 é provisionada ao criar um recurso Azure Maps através do plano de gestão Azure através de Azure portal, PowerShell, CLI, Azure SDKs ou APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.

Para aplicações publicamente expostas, a nossa recomendação é usar 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 List SAS no recurso Azure Maps através do plano de gestão Azure via portal Azure, PowerShell, CLI, Azure SDKs ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com o Azure a controlos de acesso baseados em funções e controlo minucioso da expiração, taxa e região(s) de utilização do token em questão. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token 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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LocalizedMapView	O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro de Visualização no Azure Maps deve ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde os mapas, imagens e outros dados e conteúdos de terceiros autorizados a aceder via Azure Maps estão disponíveis. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.
MapTileSize	O tamanho do bloco de mapa retornado em pixels.
TilesetID	Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os tilesets prontos a usar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

LocalizedMapView

Enumeração

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro de Visualização no Azure Maps deve ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde os mapas, imagens e outros dados e conteúdos de terceiros autorizados a aceder via Azure Maps estão disponíveis. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Valor	Description
AE	Emirados Árabes Unidos (Vista árabe)
AR	Argentina (Vista Argentina)
BH	Bahrein (Vista árabe)
IN	Índia (Vista indiana)
IQ	Iraque (Vista árabe)
JO	Jordânia (Vista árabe)
KW	Kuwait (Vista árabe)
LB	Líbano (Vista árabe)
MA	Marrocos (Vista Marroquina)
OM	Omã (Vista árabe)
PK	Paquistão (Vista paquistanesa)
PS	Autoridade Palestiniana (Vista árabe)
QA	Qatar (Vista árabe)
SA	Arábia Saudita (Vista árabe)
SY	Síria (Vista árabe)
US	United States of America
YE	Iémen (Vista árabe)
Auto	Retornar os dados do mapa com base no endereço IP da solicitação.
Unified	Modo de Exibição Unificado (Outros)

MapTileSize

Enumeração

O tamanho do bloco de mapa retornado em pixels.

Valor	Description
256	Retornar um bloco de 256 por 256 pixels.
512	Retornar um bloco de 512 por 512 pixels.

TilesetID

Enumeração

Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os tilesets prontos a usar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

Valor	Description
microsoft.base	Um mapa base é um mapa padrão que exibe estradas, características naturais e artificiais, juntamente com os rótulos para essas características em um bloco vetorial. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.labels	Exibe etiquetas para estradas, características naturais e artificiais em uma telha vetorial. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.hybrid	Exibe dados de estrada, limite e rótulo em um bloco vetorial. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.terra.main	Relevo sombreado e camadas de terra. Suporta níveis de zoom de 0 a 6. Formato: raster (png).
microsoft.base.road	Todas as camadas com o nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.darkgrey	Todas as camadas com o nosso estilo cinza escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels.road	Rotule os dados no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels.darkgrey	Rotule os dados no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid.road	Dados de estradas, limites e etiquetas no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid.darkgrey	Dados de estradas, limites e rótulos no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.imagery	Uma combinação de imagens de satélite ou aéreas. Disponível apenas em SKU de preços S1 e G2. Suporta níveis de zoom de 1 a 19. Formato: raster (png).
microsoft.weather.radar.main	Telhas de radar meteorológico. Últimas imagens de radar meteorológico, incluindo áreas de chuva, neve, gelo e condições mistas. Para mais informações sobre a cobertura do serviço meteorológico Azure Maps, consulte Azure Maps cobertura dos serviços meteorológicos. Para mais informações sobre dados de radar, consulte Serviços meteorológicos em Azure Maps. Suporta níveis de zoom de 0 a 15. Formato: raster (png).
microsoft.weather.infrared.main	Telhas infravermelhas meteorológicas. As últimas imagens de satélite infravermelho mostram nuvens pela sua temperatura. Para mais informações, consulte Azure Maps cobertura de serviços meteorológicos. Para mais informações sobre os dados de satélite devolvidos, consulte Serviços meteorológicos em Azure Maps. Suporta níveis de zoom de 0 a 15. Formato: raster (png).
microsoft.traffic.absolute	blocos de tráfego absoluto no vetor
microsoft.traffic.absolute.main	mosaicos de tráfego absolutos em raster no nosso estilo principal.
microsoft.traffic.relative	blocos de tráfego relativo no vetor
microsoft.traffic.relative.main	mosaicos de tráfego relativo em raster no nosso estilo principal.
microsoft.traffic.relative.dark	Mosaicos de tráfego relativo em raster no nosso estilo escuro.
microsoft.traffic.delay	blocos de tráfego no vetor
microsoft.traffic.delay.main	Mosaicos de tráfego em raster no nosso estilo principal
microsoft.traffic.reduced.main	Mosaicos de tráfego reduzidos em raster no nosso estilo principal
microsoft.traffic.incident	blocos incidentes no vetor