Render - Get Map Tile
Gebruik om kaarttegels in vector- of rasterindeling aan te vragen.
**
De Get Map Tiles
API is een HTTP-aanvraag GET
waarmee gebruikers kaarttegels in vector- of rasterindelingen kunnen aanvragen, meestal om te worden geïntegreerd in een kaartbeheer of SDK. Enkele voorbeeldtegels die kunnen worden aangevraagd, zijn Azure Maps wegtegels, realtime weerradartegels of de kaarttegels die zijn gemaakt met Azure Maps Creator. Standaard gebruikt Azure Maps vectortegels voor webkaartbeheer (Web SDK) en Android SDK.
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versienummer van Azure Maps API. Huidige versie is 2022-08-01 |
tileset
|
query | True |
Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster van vierkante tegels op vooraf ingestelde zoomniveaus. Elke tegelset heeft een tilesetId die kan worden gebruikt bij het indienen van aanvragen. De tilesetId voor tegelsets die zijn gemaakt met behulp van Azure Maps Creator, worden gegenereerd via de Tegelset maken-API. De kant-en-klare tegelsets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base. |
|
x
|
query | True |
integer int32 |
X-coördinaat van de tegel op het zoomraster. De waarde moet in het bereik [0, 2 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, 2 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. |
|
tile
|
query |
De grootte van de geretourneerde kaarttegel in pixels. |
||
time
|
query |
string date-time |
De gewenste datum en tijd van de aangevraagde tegel. Deze parameter moet worden opgegeven in de standaarddatum-tijdnotatie (bijvoorbeeld 2019-11-14T16:03:00-08:00), zoals gedefinieerd door ISO 8601. Deze parameter wordt alleen ondersteund wanneer de parameter tilesetId is ingesteld op een van de onderstaande waarden.
|
|
view
|
query |
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 in Azure Maps raadpleegt u de volgende artikelen voor hulp. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
object |
De tegel die is geretourneerd na een geslaagde API-aanroep. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string |
Other Status Codes |
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. In combinatie met 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.
Als u scenario's wilt implementeren, raden we u aan om 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
- Deze beveiligingsdefinitie vereist het gebruik van de
x-ms-client-id
header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.
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 gebruiksscenario's.
- Zie Microsoft identity platform overzicht 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 bij het maken van een Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met deze sleutel wordt elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze zijn uitgegeven.
Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om server-naar-servertoegang te gebruiken voor Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
SAS Token
Dit is een shared access signature-token dat wordt 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 over het verloop, de snelheid en de 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 oorsprongen te configureren op de resource Van het account toewijzen om misbruik van het genereren te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Successful Tile Request
Sample Request
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Sample Response
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Definities
Name | Description |
---|---|
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Localized |
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. |
Map |
De grootte van de geretourneerde kaarttegel in pixels. |
TilesetID |
Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster van vierkante tegels op vooraf ingestelde zoomniveaus. Elke tileset heeft een tilesetId die kan worden gebruikt bij het indienen van aanvragen. De tilesetId voor tegelsets die zijn gemaakt met Azure Maps Creator, worden gegenereerd via de API Tegelset maken. De kant-en-klare tegelsets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base. |
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 |
Aanvullende informatie over de fout. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
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) |
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. |
TilesetID
Een tegelset is een verzameling raster- of vectorgegevens die zijn opgesplitst in een uniform raster van vierkante tegels op vooraf ingestelde zoomniveaus. Elke tileset heeft een tilesetId die kan worden gebruikt bij het indienen van aanvragen. De tilesetId voor tegelsets die zijn gemaakt met Azure Maps Creator, worden gegenereerd via de API Tegelset maken. De kant-en-klare tegelsets die door Azure Maps worden geleverd, worden hieronder vermeld. Bijvoorbeeld microsoft.base.
Name | Type | Description |
---|---|---|
microsoft.base |
string |
Een basiskaart is een standaardkaart met wegen, natuurlijke en kunstmatige kenmerken, samen met de labels voor deze kenmerken in een vectortegel. Ondersteunt zoomniveaus 0 tot en met 22. Notatie: vector (pbf). |
microsoft.base.darkgrey |
string |
Alle lagen met onze donkergrijze stijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.hybrid |
string |
Hiermee worden weg-, grens- en labelgegevens in een vectortegel weergegeven. Ondersteunt zoomniveaus 0 tot en met 22. Notatie: vector (pbf). |
microsoft.base.hybrid.darkgrey |
string |
Weg-, grens- en labelgegevens in onze donkergrijze stijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.hybrid.road |
string |
Weg-, grens- en labelgegevens in onze hoofdstijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.labels |
string |
Geeft labels weer voor wegen, natuurlijke en kunstmatige kenmerken in een vectortegel. Ondersteunt zoomniveaus 0 tot en met 22. Notatie: vector (pbf). |
microsoft.base.labels.darkgrey |
string |
Label gegevens in onze donkergrijze stijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.labels.road |
string |
Label gegevens in onze hoofdstijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.base.road |
string |
Alle lagen met onze hoofdstijl. Ondersteunt zoomniveaus 0 tot en met 22. Indeling: raster (png). |
microsoft.imagery |
string |
Een combinatie van satelliet- en luchtfoto's. Alleen beschikbaar in S1-prijs-SKU. Ondersteunt zoomniveaus 1 tot en met 19. Indeling: raster (jpeg). |
microsoft.terra.main |
string |
Gearceerde reliëf- en terralagen. Ondersteunt zoomniveaus 0 tot en met 6. Indeling: raster (png). |
microsoft.traffic.absolute |
string |
absolute verkeerstegels in vector |
microsoft.traffic.absolute.main |
string |
absolute verkeerstegels in raster in onze hoofdstijl. |
microsoft.traffic.delay |
string |
verkeertegels in vector |
microsoft.traffic.delay.main |
string |
verkeerstegels in raster in onze hoofdstijl |
microsoft.traffic.incident |
string |
incidenttegels in vector |
microsoft.traffic.reduced.main |
string |
tegels met minder verkeer in raster in onze hoofdstijl |
microsoft.traffic.relative |
string |
relatieve verkeertegels in vector |
microsoft.traffic.relative.dark |
string |
relatieve verkeertegels in raster in onze donkere stijl. |
microsoft.traffic.relative.main |
string |
relatieve verkeertegels in raster in onze hoofdstijl. |
microsoft.weather.infrared.main |
string |
Infraroodtegels voor weer. Meest recente infrarood satelliet beelden toont wolken op basis van hun temperatuur. Raadpleeg de dekkingsinformatie voor Azure Maps Weerservice. Zie Weerconcepten voor meer informatie over de geretourneerde satellietgegevens. Ondersteunt zoomniveaus 0 tot en met 15. Indeling: raster (png). |
microsoft.weather.radar.main |
string |
Weerradartegels. Meest recente weerradarbeelden, waaronder gebieden met regen, sneeuw, ijs en gemengde omstandigheden. Raadpleeg de dekkingsinformatie voor Azure Maps Weerservice. Zie Weerconcepten voor meer informatie over de radargegevens. Ondersteunt zoomniveaus 0 tot en met 15. Indeling: raster (png). |