Weather - Get Current Air Quality
Ú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}
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 |
Formato deseado de la respuesta. Solo se admite |
|
|
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 |
Indica la cuenta destinada a su uso con el modelo de seguridad de identificador de Microsoft Entra. Este identificador único para la cuenta de Azure Maps se puede obtener de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
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.
Notes
- 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 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
GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887
Respuesta de muestra
{
"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 |
|---|---|
|
Air |
El objeto Calidad del Aire proporciona información completa sobre la calidad actual del aire en la ubicación especificada. Esto incluye los niveles de concentración de varios contaminantes, valores numéricos del Índice de Calidad del Aire (AQI) que indican la calidad general del aire y la identificación del contaminante dominante que afecta a la calidad del aire. Además, ofrece un resumen del nivel de riesgo, que describe brevemente los posibles riesgos para la salud y sugiere precauciones. |
|
Air |
Una variedad de objetos de calidad del aire , cada uno proporcionando información completa sobre la calidad actual del aire en la ubicación especificada. |
|
Dominant |
Identifica el contaminante con mayor concentración. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error |
|
Json |
Formato deseado de la respuesta. Solo se admite |
| Pollutant |
Información detallada sobre un contaminante individual. No se devuelve si |
|
Pollutant |
Especifica los seis tipos de contaminantes de los que realiza un seguimiento el servicio meteorológico de Azure Maps. |
|
Unit |
Un número entero que representa el tipo de unidad. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para obtener una lista completa, consulte Servicios meteorológicos en Azure Maps. |
|
Weather |
Valor específico de una unidad dada en relación con el clima. |
AirQuality
El objeto Calidad del Aire proporciona información completa sobre la calidad actual del aire en la ubicación especificada. Esto incluye los niveles de concentración de varios contaminantes, valores numéricos del Índice de Calidad del Aire (AQI) que indican la calidad general del aire y la identificación del contaminante dominante que afecta a la calidad del aire. Además, ofrece un resumen del nivel de riesgo, que describe brevemente los posibles riesgos para la salud y sugiere precauciones.
| Nombre | Tipo | Description |
|---|---|---|
| category |
string |
Proporciona una descripción de una sola palabra de la calidad del aire para el periodo de previsión en el lenguaje especificado, como Pobre, Regular o Excelente. |
| categoryColor |
string |
Proporciona un código de color hexadecimal único correspondiente a la categoría de calidad del aire para cada día del periodo de previsión. Este color ayuda a los usuarios a identificar rápidamente el nivel de calidad del aire visualmente, siendo cada color correspondiente a una categoría como Pobre, Regular o Excelente. |
| dateTime |
string (date-time) |
Fecha y hora de la observación actual, mostradas en formato ISO 8601 (aaaaaa-mm-ddThh:mm:ss-hh:mm). Por ejemplo, 2025-04-29T07:00:00-07:00. |
| description |
string |
Una explicación textual de esta calidad del aire da como resultado el idioma solicitado. |
| dominantPollutant |
Identifica el contaminante con mayor concentración. |
|
| globalIndex |
number (float) |
Proporciona una forma estandarizada internacionalmente para entender la concentración de contaminantes en el aire. Las calificaciones oscilan entre 0 y 300 en adelante, siendo cifras más altas que indican peor calidad del aire. Los contaminantes medidos incluyen PM2.5, PM10, NO2, SO2, CO y O3. |
| index |
number (float) |
El índice de calidad del aire (AQI) es una escala de valoración de la calidad del aire establecida por organismos reguladores locales. Las escalas pueden variar ampliamente según la ubicación. Para más información, véase Índice de calidad del aire en Wikipedia. |
| pollutants |
Un array que contiene información detallada sobre cada contaminante en la respuesta. Devuelta cuando el |
AirQualityResult
Una variedad de objetos de calidad del aire , cada uno proporcionando información completa sobre la calidad actual del aire en la ubicación especificada.
| Nombre | Tipo | Description |
|---|---|---|
| nextLink |
string |
Contiene la URL para obtener la siguiente página de resultados si la respuesta está paginada. Esto es útil cuando la respuesta es demasiado grande para ser devuelta en una sola llamada, permitiendo a los usuarios navegar por varias páginas de resultados. |
| results |
Resultados detallados de la calidad del aire dentro de la ubicación especificada, incluyendo propiedades como el índice de calidad del aire (IQA), el contaminante dominante, los niveles de contaminantes, el nivel de riesgo y las precauciones sugeridas. |
DominantPollutant
Identifica el contaminante con mayor concentración.
| Valor | Description |
|---|---|
| Carbon Monoxide |
El monóxido de carbono (CO) es un gas incoloro, inodoro e insípido pero altamente tóxico producido por la combustión incompleta de combustibles que contienen carbono. Las fuentes comunes incluyen gases de escape de vehículos, estufas de gas, hornos y fuegos de leña. |
| Nitrogen Dioxide |
El dióxido de nitrógeno (NO2) es un contaminante atmosférico importante. Está regulado y sujeto a las pautas de límite recomendadas establecidas por la Organización Mundial de la Salud (OMS). |
| Ozone |
El ozono (O3) es un componente clave del smog fotoquímico, la neblina marrón y dañina que envuelve muchas grandes ciudades, como resultado de una reacción fotoquímica entre la luz solar y ciertos contaminantes específicos. |
| Particulate Matter 2.5 |
El material particulado 2.5 (PM2.5) se refiere a partículas finas con diámetros que generalmente son de 2.5 micrómetros o menos. Estas partículas son más de 100 veces más delgadas que un cabello humano y pueden permanecer suspendidas en el aire durante períodos prolongados |
| Particulate Matter 10 |
El material particulado 10 (PM10) se refiere a partículas con diámetros que generalmente son de 10 micrómetros o menos. Estas partículas pueden incluir polvo, polen, hollín, humo y gotas de líquido. |
| Sulfur Dioxide |
El dióxido de azufre (SO2) es un gas inorgánico pesado e incoloro con un olor acre e irritante. Se produce principalmente mediante la quema de combustibles fósiles en centrales eléctricas e instalaciones industriales, pero también puede ser emitido por fuentes naturales como los volcanes. |
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 de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
JsonFormat
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
Información detallada sobre un contaminante individual. No se devuelve si pollutants=false.
| Nombre | Tipo | Description |
|---|---|---|
| concentration |
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 |
Tipo de contaminante. Tenga en cuenta que se pueden agregar más en cualquier momento. |
PollutantType
Especifica los seis tipos de contaminantes de los que realiza un seguimiento el servicio meteorológico de Azure Maps.
| Valor | Description |
|---|---|
| CO |
Monóxido de carbono |
| NO2 |
Dióxido de nitrógeno |
| O3 |
Ozono |
| PM2.5 |
Partículas 2.5 |
| PM10 |
Partículas 10 |
| SO2 |
Dióxido de azufre |
UnitType
Un número entero que representa el tipo de unidad. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para obtener una lista completa, consulte Servicios meteorológicos en Azure Maps.
| Valor | Description |
|---|---|
| 0 |
feet |
| 1 |
inches |
| 2 |
miles |
| 3 |
millimeter |
| 4 |
centimeter |
| 5 |
meter |
| 6 |
kilometer |
| 7 |
kilometersPerHour |
| 8 |
knots |
| 9 |
milesPerHour |
| 10 |
metersPerSecond |
| 11 |
hectoPascals |
| 12 |
inchesOfMercury |
| 13 |
kiloPascals |
| 14 |
millibars |
| 15 |
millimetersOfMercury |
| 16 |
poundsPerSquareInch |
| 17 |
Celsius |
| 18 |
Fahrenheit |
| 19 |
kelvin |
| 20 |
percent |
| 21 |
float |
| 22 |
integer |
| 31 |
MicrogramsPerCubicMeterOfAir |
WeatherUnit
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 |
Unit |
Un número entero que representa el tipo de unidad. Por ejemplo, 17 para Celsius, 18 para Fahrenheit. Se puede utilizar para la traducción de unidades. Para obtener una lista completa, consulte Servicios meteorológicos en Azure Maps. |
| value |
number (float) |
Valor redondeado. |