Partager via


Traffic - Get Traffic Incident Viewport

Utilisez pour obtenir des informations juridiques et techniques pour une fenêtre d’affichage.

L’API Traffic Incident Viewport est une requête HTTP GET qui retourne des informations juridiques et techniques pour la fenêtre d’affichage décrite dans la demande. Elle doit être appelée par les applications clientes chaque fois que la fenêtre d’affichage change (par exemple, par le biais d’un zoom, d’un mouvement panoramique, de l’accès à un emplacement ou de l’affichage d’un itinéraire). La requête doit contenir le cadre englobant et le niveau de zoom de la fenêtre d’affichage dont les informations sont nécessaires. Le retour contient des informations de version de carte, ainsi que l’ID de modèle de trafic et les ID de copyright actuels. L’ID du modèle de trafic retourné par la description de la fenêtre d’affichage est utilisé par d’autres API pour récupérer les dernières informations de trafic en vue d’un traitement ultérieur.

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

Paramètres URI

Nom Dans Obligatoire Type Description
format
path True

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

api-version
query True

string

Numéro de version de l’API Azure Maps.

boundingbox
query True

number[]

Cadre englobant de la fenêtre d’affichage de la carte dans EPSG900913 projection. le boundingbox est représenté par deux paires de valeurs décrivant ses coins (première paire pour le coin inférieur gauche et deuxième pour le coin supérieur droit). Lorsque ce point de terminaison est appelé directement, toutes les valeurs doivent être séparées par des virgules (par exemple, minY,minX,maxY,maxX). La taille maximale du cadre englobant qui peut être passé dépend du niveau de zoom demandé. La largeur et la hauteur ne peuvent pas dépasser 4 092 pixels lorsqu’elles sont affichées sur le niveau de zoom donné.

REMARQUE : Les cadres englobants qui traversent le méridien à 180° nécessitent un traitement spécial. Pour ces zones, la valeur maxX est négative, et donc inférieure à la valeur minX à l’ouest du méridien à 180°. Pour y remédier, la valeur 40075016.6855874 doit être ajoutée à la valeur maxX vraie avant qu’elle ne soit transmise dans la requête.

boundingzoom
query True

integer

int32

Niveau de zoom de la fenêtre d’affichage de la carte. Permet de déterminer si la vue peut être agrandie.

overviewbox
query True

number[]

Cadre englobant de la carte de vue d’ensemble dans EPSG900913 projection.

Utilisé dans le cas où la zone de vue d’ensemble/mini-carte a des données de copyright différentes de la carte principale. S’il n’y a pas de mini-carte, les mêmes coordonnées que boundingBox sont utilisées. Lorsque ce point de terminaison est appelé directement, les coordonnées sont passées sous la forme d’une chaîne unique contenant quatre coordonnées, séparées par des virgules.

overviewzoom
query True

integer

int32

Niveau de zoom de la carte de vue d’ensemble. S’il n’y a pas de mini-carte, utilisez le même niveau de zoom que boundingZoom.

copyright
query

boolean

Détermine les informations de copyright à retourner. Lorsque la valeur est true, le texte du droit d’auteur est retourné ; lorsque la valeur est false, seul l’index de copyright est retourné.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité d’ID Microsoft Entra. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom Type Description
200 OK

TrafficIncidentViewport

Ok

Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 2.0 . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure , il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations aux API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps .

est Authorization URL spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous créez un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et à la ou les régions d’utilisation du jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

Request traffic incident information for the selected viewport

Exemple de requête

GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2&copyright=True

Exemple de réponse

{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

Définitions

Nom Description
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

TrafficIncidentViewport

Cet objet est retourné à partir d’un appel de la fenêtre d’affichage des incidents de trafic réussi

TrafficState

Informations sur l’état du trafic

ViewpResp

Objet Viewport Response

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

Nom Type Description
json

string

Format d’échange de données de notation d’objet JavaScript

xml

string

Langage de balisage extensible

TrafficIncidentViewport

Cet objet est retourné à partir d’un appel de la fenêtre d’affichage des incidents de trafic réussi

Nom Type Description
viewpResp

ViewpResp

Objet Viewport Response

TrafficState

Informations sur l’état du trafic

Nom Type Description
@trafficAge

integer

Temps écoulé (en secondes) à partir de la création de l’ID de modèle de trafic.

@trafficModelId

string

L’ID unique appelé Traffic Model ID est utilisé dans les appels aux services Traffic Incident. Il permet d’obtenir des informations à partir de mises à jour de trafic particulières. L’ID du modèle de trafic est mis à jour toutes les minutes et est valide pendant deux minutes avant son expiration.

ViewpResp

Objet Viewport Response

Nom Type Description
@maps

string

Indique les noms internes du fournisseur de données pour les données cartographiques utilisées dans la fenêtre d’affichage. À utiliser avec les requêtes de support.

@version

string

Indique la version logicielle utilisée pour générer les informations. À utiliser avec les requêtes de support.

copyrightIds

string

Lorsque la valeur du paramètre copyright est true, elle contient le texte intégral des informations de copyright qui doivent être affichées avec les vignettes dans la fenêtre d’affichage

trafficState

TrafficState

Informations sur l’état du trafic