Traffic - Get Traffic Incident
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 obtener cobertura de incidentes de tráfico por país o región, consulte cobertura de tráfico.
GET {endpoint}/traffic/incident?api-version=2025-01-01&bbox={bbox}
GET {endpoint}/traffic/incident?api-version=2025-01-01&incidentType={incidentType}&bbox={bbox}
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
El nombre de host del servicio Azure Maps. Usa |
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para esta operación. |
|
bbox
|
query | True |
number[] |
Define un área rectangular de interés en la superficie de la Tierra. Los lados del rectángulo se especifican mediante valores de longitud y latitud y deben cumplir con el formato GeoJSON: [minLon, minLat, maxLon, maxLat]. Para obtener más información, vea RFC 7946, Sección 5.
|
|
incident
|
query |
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á destinada a usarse junto con el modelo de seguridad de Azure AD. Representa un ID único para la cuenta de Azure Maps y puede recuperarse desde la API de cuentas de Azure Maps Management Plane. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps. |
|
| Accept-Language |
string |
Idioma en el que se deben devolver los resultados del incidente de tráfico. Para obtener más información, consulte Idiomas admitidos como referencia. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
AadToken
Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos 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.
Note
- Esta definición de seguridad requiere el uso del encabezado
x-ms-client-idpara indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps. - El
Authorization URLes específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. - 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 |
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:
header
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
GET https://atlas.microsoft.com/traffic/incident?api-version=2025-01-01&bbox=-122.22,47.44,-122.19,47.61
Respuesta de muestra
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.20148,
47.609058
]
},
"id": 125193835200120000,
"properties": {
"description": "Stationary traffic on Bellevue Way SE from SE 3rd St to Bellevue Way NE / Main St.",
"delay": 125,
"endPoint": {
"type": "Point",
"coordinates": [
-122.202707,
47.610156
]
},
"endTime": "2025-05-01T20:50:41.3340000Z",
"incidentType": "Congestion",
"isRoadClosed": false,
"isTrafficJam": true,
"lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
"severity": 1,
"startTime": "2025-05-01T18:47:00.0000000Z",
"title": "Bellevue Way SE"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.195563,
47.499877
]
},
"id": 125453508966320000,
"properties": {
"description": "Slow traffic on I-405 N from Sunset Blvd NE exit [5] to exit [7].",
"delay": 141,
"endPoint": {
"type": "Point",
"coordinates": [
-122.196893,
47.531893
]
},
"endTime": "2025-05-01T19:19:00.0000000Z",
"incidentType": "Congestion",
"isRoadClosed": false,
"isTrafficJam": true,
"lastModifiedTime": "2025-05-01T18:50:41.3340000Z",
"severity": 1,
"startTime": "2025-05-01T18:47:00.0000000Z",
"title": "I-405 N"
}
}
]
}
Definiciones
| Nombre | Description |
|---|---|
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData). |
|
Features |
Especifica el tipo de |
|
Feature |
Especifica el tipo de |
|
Geo |
Especifica el tipo de |
|
Geo |
Un tipo de geometría |
|
Incident |
Especifica el tipo de incidente de tráfico. Esto se puede usar para solicitar y diferenciar entre varios tipos de incidentes. |
|
Traffic |
Especifica información detallada sobre los incidentes de tráfico. |
|
Traffic |
Objeto de característica GeoJSON que contiene el objeto Geometría y propiedades adicionales de incidentes de tráfico. |
|
Traffic |
Objeto de colección de características de GeoJSON que contiene una lista de características de incidentes de tráfico. |
ErrorAdditionalInfo
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
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto 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.
| Valor | Description |
|---|---|
| Feature |
Especifica el tipo de objeto feature de |
FeatureTypeEnum
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 |
GeoJsonObjectType
Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.
| Valor | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
Objeto |
| FeatureCollection |
Objeto |
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.
| Valor | Description |
|---|---|
| Accident |
Accidente |
| Congestion |
Congestión |
| DisabledVehicle |
DisabledVehicle |
| Miscellaneous |
Varios |
| RoadHazard |
RoadHazard |
| Construction |
Construcción |
| Weather |
Weather |
TrafficIncidentFeatureProperties
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 |
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 |
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 |
| isTrafficJam |
boolean |
Un valor de |
| 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.
|
| 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
Objeto de característica GeoJSON que contiene el objeto Geometría y propiedades adicionales de incidentes de tráfico.
| Nombre | Tipo | Description |
|---|---|---|
| geometry |
Un tipo de geometría |
|
| id |
integer (int64) |
Un identificador único para el incidente. |
| properties |
Especifica información detallada sobre los incidentes de tráfico. |
|
| type |
Especifica el tipo de |
TrafficIncidentResponse
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 |
|
|
| type |
Especifica el tipo de |