Partilhar via


Traffic - Get Traffic Incident

A API de Incidentes de Tráfego fornece incidentes de trânsito como construção, congestionamento de tráfego e acidentes, etc. dentro de uma caixa delimitadora. Também fornece metadados de tráfego para obter informações detalhadas sobre cada incidente.

A API fornece uma coleção de recursos GeoJSON de incidentes de tráfego. Cada incidente inclui duas características pontuais: o local onde você encontra o incidente e o local final de um incidente de trânsito, como o final de uma zona de construção. Para cobertura de incidentes de trânsito por país/região, consulte Cobertura de tráfego.

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}

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
query True

string

Número da versão da API do Azure Maps.

bbox
query True

number[]

Define uma área retangular de interesse na superfície da Terra. Os lados do retângulo são especificados por valores de longitude e latitude e devem aderir ao formato GeoJSON: [minLon, minLat, maxLon, maxLat]. Para obter mais informações, consulte RFC 7946, Seção 5.

  • Dimensões mínimas: A altura ou largura da caixa delimitadora deve ser de pelo menos 12 metros.
  • Área máxima: A caixa delimitadora pode cobrir uma área de até 10.000 quilômetros quadrados.
  • Inclusão de incidentes: Os incidentes de trânsito serão incluídos na resposta se se sobreporem à caixa delimitadora ou se o início, o fim ou qualquer parte do incidente passar pela caixa delimitadora. Os locais de início e fim do incidente podem estar fora da caixa delimitadora.
Exemplo: bbox=-105,37,-94,45

incidentType
query

IncidentType

Especifica o tipo de incidente de tráfego a ser retornado. Vários tipos de incidentes em uma única solicitação são suportados. Se não for especificado, os resultados incluirão todos os tipos de incidentes dentro da caixa delimitadora fornecida.

Exemplo, '&incidentType=Accident' ou '&incidentType=Accident,Construction'.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Azure AD. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps.

Accept-Language

string

Língua em que os resultados dos incidentes de trânsito devem ser devolvidos.

Para obter mais informações, consulte Idiomas suportados para referência.

Respostas

Name Tipo Description
200 OK

TrafficIncidentResponse

OK

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Notes

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento de do Maps.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Request information about a traffic incident

Pedido de amostra

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

Resposta da amostra

{
  "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
          ]
        }
      }
    }
  ]
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

IncidentType

Especifica o tipo de incidente de trânsito. Isso pode ser usado para solicitar e diferenciar entre vários tipos de incidentes.

TrafficIncidentFeatureProperties

Especifica informações detalhadas sobre os incidentes de trânsito.

TrafficIncidentFeaturesItem

Especifica o objeto de recurso GeoJSON incidente de tráfego, incluindo a geometria e propriedades adicionais.

TrafficIncidentResponse

Um objeto de coleção de recursos GeoJSON que contém uma lista de recursos de incidentes de tráfego.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

Valor Description
Feature

Especifica o tipo de objeto GeoJSON Feature.

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

Valor Description
FeatureCollection

Especifica o tipo de objeto GeoJSONFeatureCollection.

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Name Tipo Description
coordinates

number[] (double)

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente nesta ordem. de Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.

type

string

Especifica o tipo GeoJSON como Point.

IncidentType

Especifica o tipo de incidente de trânsito. Isso pode ser usado para solicitar e diferenciar entre vários tipos de incidentes.

Valor Description
Accident

Accident

Congestion

Congestion

DisabledVehicle

DisabledVehicle

Miscellaneous

Miscellaneous

RoadHazard

RoadHazard

Construction

Construction

Weather

Weather

TrafficIncidentFeatureProperties

Especifica informações detalhadas sobre os incidentes de trânsito.

Name Tipo Description
delay

number (double)

O atraso causado pelo incidente em segundos. Se não houver atraso ou não for aplicável, ele retornará zero.

description

string

Uma descrição do incidente que inclui o nome da estrada e o evento que afeta o fluxo de tráfego.

Examples:

• W 95th St entre Switzer Rd e Bluejacket Dr - construção

• WB Johnson Dr na I-435 - reparação de pontes

endPoint

object

Um objeto GeoJson Point que especificou o local final de um incidente de tráfego, como o fim de uma zona de construção.

Esse local faz parte do objeto de propriedades do incidente e, por padrão, não pode ser interpretado por analisadores para exibição no mapa.

endTime

string

A data e hora em UTC quando o incidente de trânsito terminará, formatado como um valor dateTime, conforme definido no RFC 3339, seção 5.6.

incidentType

IncidentType

Especifica o tipo de incidente de trânsito. Isso pode ser usado para solicitar e diferenciar entre vários tipos de incidentes.

isRoadClosed

boolean

Um valor de true indica que há um fechamento da estrada.

isTrafficJam

boolean

Um valor de true indica que a área da estrada abrangida por este incidente está a sofrer condições de tráfego anormais, resultando em atrasos atípicos.

lastModifiedTime

string

A data e a hora em UTC em que as informações do incidente foram atualizadas pela última vez, formatadas como um valor dateTime, conforme definido no RFC 3339, seção 5.6.

severity

integer (int32)

Especifica o nível de importância do incidente.

  • 0: Desconhecido

  • 1: Menor

  • 2: Moderado

  • 3: Maior

  • 4: Indefinido (utilizado para encerramentos de estradas e outros atrasos indefinidos)

startTime

string

A data e hora em UTC quando o incidente ocorreu, formatado como um valor dateTime, conforme definido no RFC 3339, seção 5.6.

title

string

Especifica os nomes das estradas e a direção das estradas afetadas.

TrafficIncidentFeaturesItem

Especifica o objeto de recurso GeoJSON incidente de tráfego, incluindo a geometria e propriedades adicionais.

Name Tipo Description
geometry

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

id

integer (int64)

Um ID exclusivo para o incidente.

properties

TrafficIncidentFeatureProperties

Especifica informações detalhadas sobre os incidentes de trânsito.

type

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

TrafficIncidentResponse

Um objeto de coleção de recursos GeoJSON que contém uma lista de recursos de incidentes de tráfego.

Name Tipo Description
features

TrafficIncidentFeaturesItem[]

GeoJSON objeto de recurso que contém o objeto Geometry e propriedades adicionais. Consulte RFC 7946, Seção 3.2 para obter detalhes.

type

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.