Weather - Get Current Air Quality

Referência

Service:: Maps

API Version:: 1.1

Utilize para obter informações atuais sobre a qualidade do ar que incluem potenciais riscos e precauções sugeridas.

A Get Current Air Quality API é um pedido HTTP GET que devolve informações detalhadas sobre a concentração de poluentes e o estado global da qualidade do ar atual, incluindo níveis de poluição, valores de índice de qualidade do ar, poluente dominante e uma breve declaração que resume o nível de risco e as precauções sugeridas.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
api-version	query	True	string	Número da versão da API Azure Maps.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".
language	query		string	Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.
pollutants	query		boolean	Valor booleano que devolve informações detalhadas sobre cada poluente. Por predefinição, é Verdadeiro.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas .

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Get Current Air Quality

Sample Request

HTTP

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

Sample Response

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

Definições

Name	Description
AirQuality	Informações sobre a qualidade do ar numa localização específica numa hora específica.
AirQualityResult	Este objeto é devolvido a partir de uma chamada Obter Qualidade do Ar com êxito.
DominantPollutant	Tipo de poluente. Tenha em atenção que podem ser adicionados mais em qualquer altura.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
Pollutant	Informações detalhadas sobre um poluente individual. Não devolvido se `pollutants`=falso.
PollutantType	Tipo de poluente. Tenha em atenção que podem ser adicionados mais em qualquer altura.
UnitType	Valor de ID numérico associado ao tipo de unidade que está a ser apresentada. Pode ser utilizado para tradução de unidades. Veja Serviços de meteorologia no Azure Maps para obter detalhes.
WeatherUnit	Valor específico de uma determinada unidade relacionada com as condições meteorológicas.

AirQuality

Informações sobre a qualidade do ar numa localização específica numa hora específica.

Name	Tipo	Description
category	string	Descrição de uma palavra da qualidade do ar no idioma pedido. Por exemplo, "Excelente".
categoryColor	string	Uma cor exclusiva correspondente à categoria deste resultado de qualidade do ar.
dateTime	string	Data e hora da observação atual apresentada no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
description	string	Uma explicação textual deste resultado de qualidade do ar no idioma pedido.
dominantPollutant	DominantPollutant	O poluente com a maior concentração.
globalIndex	number	Classificação da qualidade do ar normalizada internacionalmente numa escala de 0 a 300 e superior, com números mais elevados a representarem pior qualidade do ar.
index	number	Classificação da qualidade do ar num conjunto de dimensionamento por entidades reguladoras locais. As escalas podem variar bastante com base na localização. Consulte Wikipédia para obter mais informações.
pollutants	Pollutant[]	Informações sobre poluentes individuais.

AirQualityResult

Este objeto é devolvido a partir de uma chamada Obter Qualidade do Ar com êxito.

Name	Tipo	Description
nextLink	string	É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo.
results	AirQuality[]	Uma lista de todos os resultados de qualidade do ar para a localização consultada.

DominantPollutant

Tipo de poluente. Tenha em atenção que podem ser adicionados mais em qualquer altura.

Name	Tipo	Description
Carbon Monoxide	string	Monóxido de carbono ("CO")
Nitrogen Dioxide	string	Dióxido de azoto ("NO2")
Ozone	string	Ozono ("O3")
Particulate Matter 10	string	Partículas 10 ("PM10")
Particulate Matter 2.5	string	Partículas 2.5 ("PM2.5")
Sulfur Dioxide	string	Dióxido de enxofre ("SO2")

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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[]	As informações adicionais do erro.
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 a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name	Tipo	Description
json	string	O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript

Pollutant

Informações detalhadas sobre um poluente individual. Não devolvido se pollutants=falso.

Name	Tipo	Description
concentration	WeatherUnit	Um objeto que contém o número de partículas poluentes por volume de ar.
globalIndex	number	Classificação da qualidade do ar normalizada internacionalmente numa escala de 0 a 300 e superior, com números mais elevados a representarem pior qualidade do ar.
index	number	Classificação da qualidade do ar num conjunto de dimensionamento por entidades reguladoras locais. As escalas podem variar bastante com base na localização. Consulte Wikipédia para obter mais informações.
name	string	O nome do poluente em inglês.
type	PollutantType	Tipo de poluente. Tenha em atenção que podem ser adicionados mais em qualquer altura.

PollutantType