Partager via


Traffic - Get Traffic Incident

L’API Traffic Incident fournit des incidents de trafic tels que la construction, la congestion du trafic et les accidents, etc. dans un cadre englobant. Il fournit également des métadonnées de trafic pour obtenir des informations détaillées sur chaque incident.

L’API fournit une collection de fonctionnalités GeoJSON des incidents de trafic. Chaque incident comprend deux fonctionnalités de point : l’emplacement où vous rencontrez l’incident et l’emplacement final d’un incident de trafic, comme la fin d’une zone de construction. Pour connaître la couverture des incidents de circulation par pays/région, consultez la page Couverture du trafic.

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox={bbox}
GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&incidentType={incidentType}&bbox={bbox}

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
query True

string

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

bbox
query True

number[]

Définit une zone rectangulaire d’intérêt à la surface de la Terre. Les côtés du rectangle sont spécifiés par des valeurs de longitude et de latitude et doivent respecter le format GeoJSON : [minLon, minLat, maxLon, maxLat]. Pour plus d’informations, consultez RFC 7946, section 5.

  • Dimensions minimales : La hauteur ou la largeur de la boîte englobante doit être d’au moins 12 mètres.
  • Zone maximale : la boîte englobante peut couvrir une zone allant jusqu’à 10 000 kilomètres carrés.
  • Inclusion de l’incident : Les incidents de circulation seront inclus dans l’intervention s’ils chevauchent le cadre de délimitation, ou si leur début, leur fin ou une partie de l’incident passe à travers le cadre de délimitation. Les emplacements de début et de fin de l’incident peuvent se trouver en dehors de la boîte englobante.
Exemple : bbox=-105,37,-94,45

incidentType
query

IncidentType

Spécifie le type d’incident de trafic à retourner. Plusieurs types d’incidents au sein d’une seule requête sont pris en charge. Si ce n’est pas spécifié, les résultats incluent tous les types d’incidents dans la zone englobante fournie.

Exemple : '&incidentType=Accident' ou '&incidentType=Accident,Construction'.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Spécifie le compte destiné à l’utilisation conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

Accept-Language

string

Langue dans laquelle les résultats de l’incident de trafic doivent être retournés.

Pour plus d’informations, consultez la section Langues prises en charge pour référence.

Réponses

Nom Type Description
200 OK

TrafficIncidentResponse

OK

Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, 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 Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation 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 la ressource Azure Maps à laquelle l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

La Authorization URL est 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 de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST. * L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la 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 provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute 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 elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’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 List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES 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 aux régions d’utilisation pour le 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 mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Request information about a traffic incident

Exemple de requête

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox=-122.22,47.44,-122.19,47.61

Exemple de réponse

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": 125193835200120000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20148,
          47.609058
        ]
      },
      "properties": {
        "incidentType": "Congestion",
        "startTime": "2025-05-01T18:47:00.0000000Z",
        "endTime": "2025-05-01T20:50:41.3340000Z",
        "lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
        "description": "Stationary traffic on Bellevue Way SE from SE 3rd St to Bellevue Way NE / Main St.",
        "severity": 1,
        "isRoadClosed": false,
        "title": "Bellevue Way SE",
        "isTrafficJam": true,
        "delay": 125,
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -122.202707,
            47.610156
          ]
        }
      }
    },
    {
      "type": "Feature",
      "id": 125453508966320000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.195563,
          47.499877
        ]
      },
      "properties": {
        "incidentType": "Congestion",
        "startTime": "2025-05-01T18:47:00.0000000Z",
        "endTime": "2025-05-01T19:19:00.0000000Z",
        "lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
        "description": "Slow traffic on I-405 N from Sunset Blvd NE exit [5] to exit [7].",
        "severity": 1,
        "isRoadClosed": false,
        "title": "I-405 N",
        "isTrafficJam": true,
        "delay": 141,
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -122.196893,
            47.531893
          ]
        }
      }
    }
  ]
}

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

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. Pour plus d’informations, consultez la RFC 7946.

GeoJsonPoint

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.

IncidentType

Spécifie le type d’incident de trafic. Cela peut être utilisé pour demander et différencier différents types d’incidents.

TrafficIncidentFeatureProperties

Spécifie des informations détaillées sur les incidents de trafic.

TrafficIncidentFeaturesItem

Spécifie l’objet de fonctionnalité GeoJSON de l’incident de trafic, y compris la géométrie et les propriétés supplémentaires.

TrafficIncidentResponse

Objet de collection de fonctionnalités GeoJSON qui contient une liste des fonctionnalités d’incidents de trafic.

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émentaire.

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 d’erreur.

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

Valeur Description
Feature

Spécifie le type d’objet Feature GeoJSON.

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. Pour plus d’informations, consultez la RFC 7946.

Valeur Description
FeatureCollection

Spécifie le type d’objet GeoJSONFeatureCollection.

GeoJsonPoint

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.

Nom Type Description
coordinates

number[] (double)

Un Position est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont longitude et latitude, précisément dans cet ordre. altitude/élévation est un troisième élément facultatif. Pour plus d’informations, reportez-vous à RFC 7946.

type

string

Spécifie le type GeoJSON en tant que point.

IncidentType

Spécifie le type d’incident de trafic. Cela peut être utilisé pour demander et différencier différents types d’incidents.

Valeur Description
Accident

Accident

Congestion

Congestion

DisabledVehicle

DisabledVehicle

Miscellaneous

Miscellaneous

RoadHazard

RoadHazard

Construction

Construction

Weather

Weather

TrafficIncidentFeatureProperties

Spécifie des informations détaillées sur les incidents de trafic.

Nom Type Description
delay

number (double)

Délai provoqué par l’incident en secondes. Si aucun délai ou non applicable, il retourne zéro.

description

string

Description de l’incident qui inclut le nom de la route et l’événement impactant le flux de circulation.

Examples:

• W 95th St entre Switzer Rd et Bluejacket Dr - construction

• WB Johnson Dr at I-435 - réparation de pont

endPoint

object

Objet GeoJson Point qui a spécifié l’emplacement final d’un incident de trafic, tel que la fin d’une zone de construction.

Cet emplacement fait partie de l’objet de propriétés d’incident et, par défaut, ne peut pas être interprété par les analyseurs pour l’affichage sur la carte.

endTime

string

Date et heure UTC lorsque l’incident de trafic se termine, mis en forme comme valeur dateTime définie dans RFC 3339, section 5.6.

incidentType

IncidentType

Spécifie le type d’incident de trafic. Cela peut être utilisé pour demander et différencier différents types d’incidents.

isRoadClosed

boolean

Une valeur de true indique qu’il existe une fermeture routière.

isTrafficJam

boolean

Une valeur de true indique que la zone de la route couverte par cet incident rencontre des conditions anormales de circulation entraînant des retards non typiques.

lastModifiedTime

string

Date et heure UTC de la dernière mise à jour des informations d’incident, mises en forme comme valeur dateTime définie dans RFC 3339, section 5.6.

severity

integer (int32)

Spécifie le niveau d’importance de l’incident.

  • 0 : Inconnu

  • 1 : Mineur

  • 2 : Modéré

  • 3 : Majeur

  • 4 : Non défini (utilisé pour les fermetures de routes et autres retards indéfinis)

startTime

string

Date et heure UTC lorsque l’incident s’est produit, mis en forme comme valeur dateTime telle que définie dans RFC 3339, section 5.6.

title

string

Spécifie les noms et la direction des routes affectées.

TrafficIncidentFeaturesItem

Spécifie l’objet de fonctionnalité GeoJSON de l’incident de trafic, y compris la géométrie et les propriétés supplémentaires.

Nom Type Description
geometry

GeoJsonPoint

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.

id

integer (int64)

ID unique de l’incident.

properties

TrafficIncidentFeatureProperties

Spécifie des informations détaillées sur les incidents de trafic.

type

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

TrafficIncidentResponse

Objet de collection de fonctionnalités GeoJSON qui contient une liste des fonctionnalités d’incidents de trafic.

Nom Type Description
features

TrafficIncidentFeaturesItem[]

GeoJSON objet de fonctionnalité qui contient un objet Geometry et des propriétés supplémentaires. Pour plus d’informations, reportez-vous à RFC 7946, section 3.2.

type

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. Pour plus d’informations, consultez la RFC 7946.