Weather - Get Current Air Quality

Referencia

Servicio:: Maps

Versión de la API:: 1.1

Úselo para obtener información actualizada sobre la calidad del aire que incluya los riesgos potenciales y las precauciones sugeridas.

La Get Current Air Quality API es una solicitud HTTP GET que devuelve información detallada sobre la concentración de contaminantes y el estado general de la calidad del aire actual, incluidos los niveles de contaminación, los valores del índice de calidad del aire, el contaminante dominante y una breve declaración que resume el nivel de riesgo y las precauciones sugeridas.

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query={query}

Con parámetros opcionales:

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	number[]	La consulta aplicable especificada como una cadena separada por comas compuesta por latitud seguida de longitud, por ejemplo, "47.641268,-122.125679". La información meteorológica generalmente está disponible para ubicaciones en tierra, cuerpos de agua rodeados de tierra y áreas del océano que se encuentran dentro de aproximadamente 50 millas náuticas de una costa.
language	query		string	Idioma en el que se deben devolver los resultados de la búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte idiomas admitidos para obtener más información.
pollutants	query		boolean	Valor booleano que devuelve información detallada sobre cada contaminante. De forma predeterminada es True.

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 Id. de Microsoft Entra. 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 del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	AirQualityResult	De acuerdo
Other Status Codes	ErrorResponse	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

Get Current Air Quality

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887

Respuesta de muestra

status code:: 200

{
  "results": [
    {
      "dateTime": "2021-07-19T02:00:00+00:00",
      "index": 21.6,
      "globalIndex": 22.1,
      "dominantPollutant": "Ozone",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "pollutants": [
        {
          "type": "NO2",
          "name": "Nitrogen Dioxide",
          "index": 6.7,
          "globalIndex": 6.7,
          "concentration": {
            "value": 13.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "O3",
          "name": "Ozone",
          "index": 21.6,
          "globalIndex": 22.1,
          "concentration": {
            "value": 53.5,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM10",
          "name": "Particulate Matter 10",
          "index": 11.3,
          "globalIndex": 12.2,
          "concentration": {
            "value": 12.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "PM2.5",
          "name": "Particulate Matter 2.5",
          "index": 13.5,
          "globalIndex": 6.5,
          "concentration": {
            "value": 3.2,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "CO",
          "name": "Carbon Monoxide",
          "index": 1.2,
          "globalIndex": 0.6,
          "concentration": {
            "value": 118.4,
            "unit": "µg/m³",
            "unitType": 31
          }
        },
        {
          "type": "SO2",
          "name": "Sulfur Dioxide",
          "index": 0.6,
          "globalIndex": 1.1,
          "concentration": {
            "value": 1.1,
            "unit": "µg/m³",
            "unitType": 31
          }
        }
      ]
    }
  ]
}

Definiciones

Nombre	Description
AirQuality	Información sobre la calidad del aire en un lugar específico en un momento específico.
AirQualityResult	Este objeto se devuelve de una llamada correcta Get Air Quality.
DominantPollutant	Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
JsonFormat	Formato deseado de la respuesta. Solo se admite `json` formato.
Pollutant	Información detallada sobre un contaminante individual. No se devuelve si `pollutants`=false.
PollutantType	Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.
UnitType	Valor de ID numérico asociado al tipo de unidad que se muestra. Se puede utilizar para la traducción de unidades. Consulte Servicios meteorológicos en Azure Maps para obtener más información.
WeatherUnit	Valor específico de una unidad dada en relación con el clima.

AirQuality

Object

Información sobre la calidad del aire en un lugar específico en un momento específico.

Nombre	Tipo	Description
category	string	Descripción de una palabra de la calidad del aire en el idioma solicitado. Por ejemplo, "Excelente".
categoryColor	string	Un color único que corresponde a la categoría de este resultado de calidad del aire.
dateTime	string (date-time)	La fecha y la hora de la observación actual se muestran en formato ISO 8601, por ejemplo, 2019-10-27T19:39:57-08:00.
description	string	Una explicación textual de esta calidad del aire da como resultado el idioma solicitado.
dominantPollutant	DominantPollutant	El contaminante con la mayor concentración.
globalIndex	number (float)	Calificación de la calidad del aire normalizada internacionalmente en una escala de 0 a 300 en adelante, donde los números más altos representan la peor calidad del aire.
index	number (float)	Calificación de la calidad del aire en una escala establecida por los organismos reguladores locales. Las escalas pueden variar ampliamente según la ubicación. Véase Wikipedia para más información.
pollutants	Pollutant[]	Información sobre contaminantes individuales.

AirQualityResult

Object

Este objeto se devuelve de una llamada correcta Get Air Quality.

Nombre	Tipo	Description
nextLink	string	es el vínculo a la página siguiente de las características devueltas. Si es la última página, no hay este campo.
results	AirQuality[]	Una lista de todos los resultados de calidad del aire para la ubicación consultada.

DominantPollutant

Enumeración

Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.

Valor	Description
Carbon Monoxide	Monóxido de carbono ("CO")
Nitrogen Dioxide	Dióxido de nitrógeno ("NO2")
Ozone	Ozono ("O3")
Particulate Matter 10	Material particulado 10 ("PM10")
Particulate Matter 2.5	Material particulado 2.5 ("PM2.5")
Sulfur Dioxide	Dióxido de azufre ("SO2")

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	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

JsonFormat

Enumeración

Formato deseado de la respuesta. Solo se admite json formato.

Valor	Description
json	el formato de intercambio de datos de notación de objetos JavaScript

Pollutant

Object

Información detallada sobre un contaminante individual. No se devuelve si pollutants=false.

Nombre	Tipo	Description
concentration	WeatherUnit	Objeto que contiene el número de partículas contaminantes por volumen de aire.
globalIndex	number (float)	Calificación de la calidad del aire normalizada internacionalmente en una escala de 0 a 300 en adelante, donde los números más altos representan la peor calidad del aire.
index	number (float)	Calificación de la calidad del aire en una escala establecida por los organismos reguladores locales. Las escalas pueden variar ampliamente según la ubicación. Véase Wikipedia para más información.
name	string	El nombre del contaminante en inglés.
type	PollutantType	Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.

PollutantType

Enumeración

Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento.

Valor	Description
CO	Monóxido de carbono ("CO")
NO2	Dióxido de nitrógeno ("NO2")
O3	Ozono ("O3")
PM10	Material particulado 10 ("PM10")
PM2.5	Material particulado 2.5 ("PM2.5")
SO2	Dióxido de azufre ("SO2")

UnitType

Enumeración

Valor de ID numérico asociado al tipo de unidad que se muestra. Se puede utilizar para la traducción de unidades. Consulte Servicios meteorológicos en Azure Maps para obtener más información.

Valor	Description
0	pies
1	Pulgadas
10	metrospor segundo
11	hectoPascales
12	pulgadasOfMercurio
13	kiloPascales
14	Milibares
15	milímetrosDeMercurio
16	librasPorPulgada Cuadrada
17	grados centígrados
18	grados Fahrenheit
19	grados Kelvin
2	millas
20	por ciento
21	flotante
22	entero
3	Milímetro
31	MicrogramosPerCubicMeterOfAir
4	centímetro
5	Metro
6	kilómetro
7	kilómetrosPor hora
8	Nudos
9	millasPor hora

WeatherUnit

Object

Valor específico de una unidad dada en relación con el clima.

Nombre	Tipo	Description
unit	string	Tipo de unidad para el valor devuelto.
unitType	UnitType (int32)	Valor de ID numérico asociado al tipo de unidad que se muestra. Se puede utilizar para la traducción de unidades. Consulte Servicios meteorológicos en Azure Maps para obtener más información.
value	number (float)	Valor redondeado.

Compartir a través de

Weather - Get Current Air Quality

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Get Current Air Quality

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AirQuality

AirQualityResult

DominantPollutant

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

Pollutant

PollutantType

UnitType

WeatherUnit