Traffic - Get Traffic Incident Viewport

Referencia

Service:: Maps

API Version:: 1.0

Use para obtener información legal y técnica de una ventanilla.

La Traffic Incident Viewport API es una solicitud HTTP GET que devuelve información legal y técnica para la ventanilla descrita en la solicitud. Las aplicaciones cliente deben llamar a ella cada vez que cambie la ventanilla (por ejemplo, mediante zoom, movimiento panorámico, ir a una ubicación o mostrar una ruta). La solicitud debe contener el rectángulo delimitador y el nivel de zoom de la ventanilla cuya información es necesaria. La devolución contendrá información de la versión del mapa, así como el identificador actual del modelo de tráfico y los identificadores de copyright. Otras API usan el identificador del modelo de tráfico devuelto por la descripción de la ventanilla para recuperar la última información de tráfico para su posterior procesamiento.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
api-version	query	True	string	Número de versión de la API de Azure Maps.
boundingbox	query	True	number[]	Rectángulo de selección de la ventanilla de mapa en EPSG900913 proyección. `boundingbox` se representa mediante dos pares de valores que describen las esquinas (primer par para la esquina inferior izquierda y la segunda para la esquina superior derecha). Cuando se llama directamente a este punto de conexión, todos los valores deben estar separados por comas (por ejemplo, minY,minX,maxY,maxX). El tamaño máximo del rectángulo de límite que se puede pasar depende del nivel de zoom solicitado. El ancho y alto no pueden superar los 4092 píxeles cuando se representan en el nivel de zoom especificado. NOTA: Los cuadros de límite que cruzan el meridiano de 180° requieren un tratamiento especial. Para estos cuadros, el valor maxX oriental será negativo y, por tanto, menor que el valor minX al oeste del meridiano de 180°. Para solucionarlo, el valor 40075016.6855874 debe agregarse al valor maxX true antes de pasarla en la solicitud.
boundingzoom	query	True	integer int32	Nivel de zoom de la ventanilla del mapa. Se usa para determinar si la vista se puede acercar.
overviewbox	query	True	number[]	Rectángulo de selección del mapa de información general en EPSG900913 proyección. Se usa en caso de que el cuadro de información general o el mini mapa tenga datos de copyright diferentes que el mapa principal. Si no hay ningún mini mapa, se usan las mismas coordenadas que `boundingBox` se usan. Cuando se llama directamente a este punto de conexión, las coordenadas se pasan como una sola cadena que contiene cuatro coordenadas, separadas por comas.
overviewzoom	query	True	integer int32	Nivel de zoom del mapa de información general. Si no hay ningún mini mapa, use el mismo nivel de zoom que boundingZoom.
copyright	query		boolean	Determina qué información de copyright se va a devolver. Cuando es true, se devuelve el texto de copyright; cuando solo se devuelve el índice de copyright false.

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 Microsoft Entra ID. 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 Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	TrafficIncidentViewport	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

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

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de 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 x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps .

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 Microsoft Entra ID. * 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, CLI, SDK de Azure o API REST. * El uso del 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 Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Create una cuenta de Azure Maps en el 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.

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

Type: apiKey
In: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea 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 está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 controlen 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 la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Request traffic incident information for the selected viewport

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
TrafficIncidentViewport	Este objeto se devuelve de una llamada correcta a la ventanilla de incidentes de tráfico.
TrafficState	Información sobre el estado del tráfico
ViewpResp	Viewport Response (objeto)

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	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript
xml	string	Lenguaje de marcado extensible

TrafficIncidentViewport

Este objeto se devuelve de una llamada correcta a la ventanilla de incidentes de tráfico.

Nombre	Tipo	Description
viewpResp	ViewpResp	Viewport Response (objeto)

TrafficState

Información sobre el estado del tráfico

Nombre	Tipo	Description
@trafficAge	integer	Tiempo transcurrido (en segundos) desde la creación del identificador del modelo de tráfico.
@trafficModelId	string	El identificador único denominado Id. de modelo de tráfico se usa en llamadas a los servicios de incidentes de tráfico. Permite obtener información de actualizaciones de tráfico concretas. El identificador del modelo de tráfico se actualiza cada minuto y es válido durante dos minutos antes de que se agote el tiempo de espera.

ViewpResp

Viewport Response (objeto)

Nombre	Tipo	Description
@maps	string	Indica los nombres internos del proveedor de datos para los datos de mapa usados en la ventanilla. Para su uso con consultas de soporte técnico.
@version	string	Indica la versión de software utilizada para generar la información. Para su uso con consultas de soporte técnico.
copyrightIds	string	Cuando el valor del parámetro copyright es true, contiene el texto completo de la información de copyright que se debe mostrar con los iconos en la ventanilla.
trafficState	TrafficState	Información sobre el estado del tráfico

Share via