Render - Get Map Tile

Service:

Maps

API Version:

1.0

gebruiken om kaarttegels in vector- of rasterindeling op te halen die doorgaans moeten worden geïntegreerd in een nieuw kaartbeheer of een nieuwe SDK.

Notitie

buitengebruikstelling van Azure Maps Render v1-service

De Azure Maps Render v1-service is nu afgeschaft en wordt op 17-9-26 buiten gebruik gesteld. Om serviceonderbrekingen te voorkomen, moeten alle aanroepen van de Render v1-API worden bijgewerkt om render v2 API te gebruiken voor 17-9-26.

Hiermee worden kaarttegels in vector- of rasterindeling opgehaald die doorgaans moeten worden geïntegreerd in een nieuw kaartbeheer of een nieuwe SDK. Standaard gebruikt Azure vectorkaarttegels voor het webkaartbeheer (zie Zoomniveaus en Tegelraster)

Opmerking: Weertegels zijn alleen beschikbaar via Get Map Tile V2 API. We raden u aan om te beginnen met het gebruik van de nieuwe 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}

With optional parameters:

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}

URI-parameters

Name	In	Vereist	Type	Description
format	path	True	TileFormat	Gewenste indeling van het antwoord. Mogelijke waarden zijn png & pbf.
api-version	query	True	string	Versienummer van Azure Maps API.
layer	query	True	MapTileLayer	Kaartlaag aangevraagd. Mogelijke waarden zijn basic, hybride, labels en terra.
style	query	True	MapTileStyle	Kaartstijl die moet worden geretourneerd. Mogelijke waarden zijn hoofd, donker en shaded_relief.
x	query	True	integer int32	X-coördinaat van de tegel op het zoomraster. De waarde moet in het bereik [0, 2zoom -1] liggen. Zie Zoomniveaus en Tegelraster voor meer informatie.
y	query	True	integer int32	Y-coördinaat van de tegel op het zoomraster. De waarde moet in het bereik [0, 2zoom -1] liggen. Zie Zoomniveaus en Tegelraster voor meer informatie.
zoom	query	True	integer int32	Zoomniveau voor de gewenste tegel. Zie Zoomniveaus en Tegelraster voor meer informatie.
language	query		string	Taal waarin zoekresultaten moeten worden geretourneerd. Moet een van de ondersteunde IETF-taaltags zijn, niet hoofdlettergevoelig. Wanneer gegevens in de opgegeven taal niet beschikbaar zijn voor een specifiek veld, wordt de standaardtaal gebruikt. Raadpleeg Ondersteunde talen voor meer informatie.
tileSize	query		MapTileSize	De grootte van de geretourneerde kaarttegel in pixels.
view	query		LocalizedMapView	Met de parameter View (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten voor een bepaald land/regio weergeven voor geopolitiek betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de weergaveparameter kan uw toepassing voldoen aan de weergave die is vereist voor het land/de regio die uw toepassing gaat bedienen. De parameter View is standaard ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de weergaveparameter correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter View in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN. Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Antwoorden

Name	Type	Description
200 OK	object	Deze afbeelding wordt geretourneerd na een geslaagde aanroep Kaarttegel ophalen Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

• Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

• Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account maakt in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successful Tile Request

Sample Request

HTTP

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

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{file}"

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
LocalizedMapView	Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land of bepaalde regio voor geopolitieke betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de parameter Weergave kan uw toepassing voldoen aan de weergave die vereist is voor het land/de regio die uw toepassing gaat bedienen. De parameter Weergave is standaard ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de parameter Weergave correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter Weergave in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN. Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.
MapTileLayer	Toewijzingslaag aangevraagd. Mogelijke waarden zijn basic, hybrid, labels en terra.
MapTileSize	De grootte van de geretourneerde kaarttegel in pixels.
MapTileStyle	Kaartstijl die moet worden geretourneerd. Mogelijke waarden zijn main, dark en shaded_relief.
TileFormat	Gewenste indeling van het antwoord. Mogelijke waarden zijn png & pbf.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

LocalizedMapView

Met de parameter Weergave (ook wel de parameter 'gebruikersregio' genoemd) kunt u de juiste kaarten weergeven voor een bepaald land of bepaalde regio voor geopolitieke betwiste regio's. Verschillende landen/regio's hebben verschillende weergaven van dergelijke regio's en met de parameter Weergave kan uw toepassing voldoen aan de weergave die vereist is voor het land/de regio die uw toepassing gaat bedienen. De parameter Weergave is standaard ingesteld op Unified, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Het is uw verantwoordelijkheid om de locatie van uw gebruikers te bepalen en vervolgens de parameter Weergave correct in te stellen voor die locatie. U kunt ook 'View=Auto' instellen, waarmee de kaartgegevens worden geretourneerd op basis van het IP-adres van de aanvraag. De parameter Weergave in Azure Maps moet worden gebruikt in overeenstemming met de toepasselijke wetgeving, met inbegrip van die met betrekking tot toewijzing, van het land of de regio waar kaarten, afbeeldingen en andere gegevens en inhoud van derden waartoe u toegang hebt via Azure Maps beschikbaar wordt gesteld. Voorbeeld: view=IN.

Raadpleeg Ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken.

Name	Type	Description
AE	string	Verenigde Arabische Emiraten (Arabische weergave)
AR	string	Argentinië (Argentijnse weergave)
Auto	string	Retourneer de kaartgegevens op basis van het IP-adres van de aanvraag.
BH	string	Bahrein (Arabische weergave)
IN	string	India (Indiase weergave)
IQ	string	Irak (Arabische weergave)
JO	string	Jordanië (Arabische weergave)
KW	string	Koeweit (Arabische weergave)
LB	string	Libanon (Arabische weergave)
MA	string	Marokko (Marokkaanse weergave)
OM	string	Oman (Arabische weergave)
PK	string	Pakistan (Pakistaanse weergave)
PS	string	Palestijnse Autoriteit (Arabische weergave)
QA	string	Qatar (Arabische weergave)
SA	string	Saoedi-Arabië (Arabische weergave)
SY	string	Syrië (Arabische weergave)
Unified	string	Geïntegreerde weergave (overige)
YE	string	Jemen (Arabische weergave)

MapTileLayer

Toewijzingslaag aangevraagd. Mogelijke waarden zijn basic, hybrid, labels en terra.

Name	Type	Description
basic	string	Retourneert een tegel met alle kaartfuncties, waaronder veelhoeken, randen, wegen en labels.
hybrid	string	Retourneert een tegel met randen, wegen en labels, en kan worden bedekt op andere tegels (zoals satellietbeelden) om hybride tegels te produceren.
labels	string	Retourneert een tegel met alleen de labelgegevens van de kaart.
terra	string	Kaartcanvas compleet met gearceerde reliëftegels. Zoomniveaus 0-6 (inclusief) worden ondersteund. Png is de enige ondersteunde TileFormat en alleen beschikbare MapTileSize is 512.

MapTileSize

De grootte van de geretourneerde kaarttegel in pixels.

Name	Type	Description
256	string	Retourneer een tegel van 256 x 256 pixels.
512	string	Retourneer een tegel van 512 bij 512 pixels.

MapTileStyle

Kaartstijl die moet worden geretourneerd. Mogelijke waarden zijn main, dark en shaded_relief.

Name	Type	Description
dark	string	Donkergrijze versie van de Azure Maps hoofdstijl. PNG is de enige ondersteunde TileFormat.
main	string	Azure Maps hoofdstijl
shaded_relief	string	Azure Maps stijl voltooid met gearceerd reliëf. Ondersteund door Laag terra.

TileFormat

Gewenste indeling van het antwoord. Mogelijke waarden zijn png & pbf.

Name	Type	Description
pbf	string	Vectorafbeelding in de pbf-indeling. Ondersteunt zoomniveaus 0 tot en met 22.
png	string	Een afbeelding in de png-indeling. Ondersteunt zoomniveaus 0 tot en met 18.