Traffic - Get Traffic Incident

Referencia

Servicio:: Maps

Versión de la API:: 2025-01-01

Traffic Incident API proporciona incidentes de tráfico como la construcción, la congestión del tráfico y los accidentes, etc. dentro de un rectángulo de límite. También proporciona metadatos de tráfico para obtener información detallada sobre cada incidente.

La API proporciona una colección de características de GeoJSON de incidentes de tráfico. Cada incidente incluye dos características puntuales: la ubicación donde se encuentra el incidente y la ubicación final de un incidente de tráfico, como el final de una zona de construcción. Para la cobertura de incidentes de tráfico por país o región, consulte cobertura de tráfico.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Número de versión de la API de Azure Maps.
bbox	query	True	number[]	Un área rectangular para el área de interés en la Tierra. Los lados de los rectángulos se definen mediante valores de longitud y latitud. Debe cumplir el formato GeoJSON [minLon, minLat, maxLon, maxLat]. Para obtener más información, vea RFC 7946, Sección 5. El alto o ancho del rectángulo de límite debe ser de al menos 12 m y no superar los 500 000m. Se aplica un límite máximo de 30 grados para el ancho o alto. (maxLon - minLon debe <= 30 y maxLat - minLat debe <= 30). Ejemplo: bbox=-105,37,-94,45
incidentType	query		IncidentType	Especifica el tipo de incidente de tráfico que se va a devolver. Se admiten varios tipos de incidentes dentro de una sola solicitud. Si no se especifica, los resultados incluirán todos los tipos de incidentes dentro del cuadro de límite proporcionado. Por ejemplo, "&incidentType=Accident" o "&incidentType=Accident,Construction".

Nombre

Requerido

Tipo

Description

api-version

query

True

string

Número de versión de la API de Azure Maps.

bbox

query

True

number[]

Un área rectangular para el área de interés en la Tierra. Los lados de los rectángulos se definen mediante valores de longitud y latitud. Debe cumplir el formato GeoJSON [minLon, minLat, maxLon, maxLat]. Para obtener más información, vea RFC 7946, Sección 5.

El alto o ancho del rectángulo de límite debe ser de al menos 12 m y no superar los 500 000m. Se aplica un límite máximo de 30 grados para el ancho o alto. (maxLon - minLon debe <= 30 y maxLat - minLat debe <= 30).

Ejemplo: bbox=-105,37,-94,45

incidentType

query

IncidentType

Especifica el tipo de incidente de tráfico que se va a devolver. Se admiten varios tipos de incidentes dentro de una sola solicitud. Si no se especifica, los resultados incluirán todos los tipos de incidentes dentro del cuadro de límite proporcionado.

Por ejemplo, "&incidentType=Accident" o "&incidentType=Accident,Construction".

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de Azure AD en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.
Accept-Language		string	Idioma en el que se deben devolver los resultados del incidente de tráfico. Para obtener más información, vea de idiomas admitidos para obtener referencia.

Nombre

Requerido

Tipo

Description

x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de Azure AD en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Accept-Language

string

Idioma en el que se deben devolver los resultados del incidente de tráfico.

Para obtener más información, vea de idiomas admitidos para obtener referencia.

Respuestas

Nombre	Tipo	Description
200 OK	TrafficIncidentResponse	De acuerdo
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de de Maps.

El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso de sdk web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Request information about a traffic incident

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox=-105,37,-94,45

Respuesta de muestra

status code:: 200

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": 18558549332008001,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -104.939053,
          39.682642
        ]
      },
      "properties": {
        "startTime": "2025-09-12T09:31:37Z",
        "endTime": "2025-09-12T10:21:47Z",
        "description": "At CO 2/Colorado Boulevard (Denver) at Mile Point 204. Two right lanes are closed due to a crash.",
        "title": "I-25 N / US-87 N",
        "incidentType": "Accident",
        "severity": 4,
        "delay": null,
        "lastModifiedTime": "2025-09-12T10:21:47Z",
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -104.940412,
            39.68307
          ]
        },
        "isTrafficJam": false,
        "isRoadClosed": false
      }
    },
    {
      "type": "Feature",
      "id": 21366103288104000,
      "geometry": {
        "type": "Point",
        "coordinates": [
          -94.38411355,
          39.04460549
        ]
      },
      "properties": {
        "startTime": "2025-09-12T09:42:32Z",
        "endTime": "2025-09-12T10:21:47Z",
        "description": "Accident on I-70 E from S Lees Summit Rd/Exit 14 (I-70) to I-470/MO-291/Exit 15 (I-70).",
        "title": "I-70 E",
        "incidentType": "Accident",
        "severity": 4,
        "delay": 10,
        "lastModifiedTime": "2025-09-12T10:21:47Z",
        "endPoint": {
          "type": "Point",
          "coordinates": [
            -94.35559355,
            39.04075549
          ]
        },
        "isTrafficJam": true,
        "isRoadClosed": false
      }
    }
  ]
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FeaturesItemTypeEnum	Especifica el tipo de `GeoJSON`. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.
FeatureTypeEnum	Especifica el tipo de `GeoJSON`. El único tipo de objeto admitido es `FeatureCollection`. Para obtener más información, vea RFC 7946.
GeoJsonPoint	Un tipo de geometría `GeoJSON Point` válido. Consulte RFC 7946 para obtener más información.
IncidentType	Especifica el tipo de incidente de tráfico. Esto se puede usar para solicitar y diferenciar entre varios tipos de incidentes.
TrafficIncidentFeatureProperties	Especifica información detallada sobre los incidentes de tráfico.
TrafficIncidentFeaturesItem	Especifica el objeto de característica GeoJSON del incidente de tráfico, incluida la geometría y las propiedades adicionales.
TrafficIncidentResponse	Objeto de colección de características de GeoJSON que contiene una lista de características de incidentes de tráfico.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FeaturesItemTypeEnum

Enumeración

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.

Valor	Description
Feature	Especifica el tipo de objeto feature de `GeoJSON`.

FeatureTypeEnum

Enumeración

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.

Valor	Description
FeatureCollection	Especifica el tipo de objeto `GeoJSONFeatureCollection`.

GeoJsonPoint

Object

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[] (double)	Un `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. altitud/elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string	Especifica el tipo GeoJSON como Point.

IncidentType

Enumeración

Especifica el tipo de incidente de tráfico. Esto se puede usar para solicitar y diferenciar entre varios tipos de incidentes.

Valor	Description
Accident	Accidente
Alert	Alerta
Congestion	Congestión
Construction	Construcción
DisabledVehicle	DisabledVehicle
MassTransit	MassTransit
Miscellaneous	Varios
OtherNews	OtherNews
PlannedEvent	PlannedEvent
RoadHazard	RoadHazard
Weather	Tiempo

TrafficIncidentFeatureProperties

Object

Especifica información detallada sobre los incidentes de tráfico.

Nombre	Tipo	Description
delay	number (double)	Retraso causado por el incidente en segundos. Si no se aplica ningún retraso o no es aplicable, devuelve cero.
description	string	Descripción del incidente que incluye el nombre de la carretera y el evento que afecta al flujo de tráfico. Ejemplos: • W 95th St between Switzer Rd and Bluejacket Dr - construcción • WB Johnson Dr en I-435 - reparación del puente
endPoint	object	Objeto GeoJson Point que especificó la ubicación final de un incidente de tráfico, como el final de una zona de construcción. Esta ubicación forma parte del objeto de propiedades del incidente y, de forma predeterminada, no se puede interpretar mediante analizadores para mostrarlos en el mapa.
endTime	string	Fecha y hora en UTC en que finalizará el incidente de tráfico, con formato de valor dateTime, tal como se define en RFC 3339, sección 5.6.
incidentType	IncidentType	Especifica el tipo de incidente de tráfico. Esto se puede usar para solicitar y diferenciar entre varios tipos de incidentes.
isRoadClosed	boolean	Un valor de `true` indica que hay un cierre de carretera.
isTrafficJam	boolean	Un valor de `true` indica que el área de carretera cubierta por este incidente está experimentando condiciones anómalas de tráfico, lo que da lugar a retrasos no típicos.
lastModifiedTime	string	Fecha y hora en UTC en que se actualizó por última vez la información del incidente, con el formato de un valor dateTime tal como se define en RFC 3339, sección 5.6.
severity	integer (int32)	Especifica el nivel de importancia del incidente. 1: LowImpact 2: Menor 3: Moderado 4: Grave
startTime	string	Fecha y hora en UTC en que se produjo el incidente, con formato de valor dateTime, tal como se define en RFC 3339, sección 5.6.
title	string	Especifica los nombres de carretera y la dirección de las carreteras afectadas.

TrafficIncidentFeaturesItem

Object

Especifica el objeto de característica GeoJSON del incidente de tráfico, incluida la geometría y las propiedades adicionales.

Nombre	Tipo	Description
geometry	GeoJsonPoint	Un tipo de geometría `GeoJSON Point` válido. Consulte RFC 7946 para obtener más información.
id	integer (int64)	Un identificador único para el incidente.
properties	TrafficIncidentFeatureProperties	Especifica información detallada sobre los incidentes de tráfico.
type	FeaturesItemTypeEnum	Especifica el tipo de `GeoJSON`. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.

TrafficIncidentResponse

Object

Objeto de colección de características de GeoJSON que contiene una lista de características de incidentes de tráfico.

Nombre	Tipo	Description
features	TrafficIncidentFeaturesItem[]	`GeoJSON` objeto de característica que contiene el objeto Geometry y propiedades adicionales. Consulte RFC 7946, sección 3.2 para obtener más información.
type	FeatureTypeEnum	Especifica el tipo de `GeoJSON`. El único tipo de objeto admitido es `FeatureCollection`. Para obtener más información, vea RFC 7946.

Compartir a través de

Traffic - Get Traffic Incident

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Request information about a traffic incident

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

IncidentType

TrafficIncidentFeatureProperties

TrafficIncidentFeaturesItem

TrafficIncidentResponse