Weather - Get Current Air Quality

Referência

Service:: Maps

API Version:: 1.1

Use para obter informações atuais de qualidade do ar que incluem riscos potenciais e precauções sugeridas.

A Get Current Air Quality API é uma solicitação HTTP GET que retorna informações detalhadas sobre a concentração de poluentes e status geral para a qualidade do ar atual, incluindo níveis de poluição, valores de índice de qualidade do ar, o poluente dominante e uma breve declaração resumindo 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 de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
api-version	query	True	string	Número de versão da API de Mapas Azure.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida por longitude, por exemplo, "47.641268,-122.125679".
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.
pollutants	query		boolean	Valor booliano que retorna informações detalhadas sobre cada poluente. Por padrão, é True.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	AirQualityResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.

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

Observações

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

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 Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

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

Scopes

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Create uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

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

Type: apiKey
In: query

SAS Token

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

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiõ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 maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token 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

Nome	Description
AirQuality	Informações sobre a qualidade do ar em um local específico em um momento específico.
AirQualityResult	Esse objeto é retornado de uma chamada get air quality bem-sucedida.
DominantPollutant	Tipo de poluente. Observe que mais podem ser adicionados a qualquer momento.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
Pollutant	Informações detalhadas sobre um poluente individual. Não retornado se `pollutants`=false.
PollutantType	Tipo de poluente. Observe que mais podem ser adicionados a qualquer momento.
UnitType	Valor de ID numérica associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidade. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes.
WeatherUnit	Valor específico de uma determinada unidade relacionada ao clima.

AirQuality

Informações sobre a qualidade do ar em um local específico em um momento específico.

Nome	Tipo	Description
category	string	Descrição de uma palavra da qualidade do ar no idioma solicitado. Por exemplo, "Excelente".
categoryColor	string	Uma cor exclusiva correspondente à categoria desse resultado de qualidade do ar.
dateTime	string	Data e hora da observação atual exibida no formato ISO 8601, por exemplo, 2019-10-27T19:39:57-08:00.
description	string	Uma explicação textual desse resultado de qualidade do ar no idioma solicitado.
dominantPollutant	DominantPollutant	O poluente com maior concentração.
globalIndex	number	Classificação internacionalmente normalizada da qualidade do ar em uma escala de 0 a 300 ou mais, com números mais altos representando pior qualidade do ar.
index	number	Classificação de qualidade do ar em um conjunto de dimensionamento por órgãos reguladores locais. As escalas podem variar amplamente com base na localização. Consulte Wikipédia para obter mais informações.
pollutants	Pollutant[]	Informações sobre poluentes individuais.

AirQualityResult

Esse objeto é retornado de uma chamada get air quality bem-sucedida.

Nome	Tipo	Description
nextLink	string	O é o link para a próxima página dos recursos retornados. Se for a última página, não este campo.
results	AirQuality[]	Uma lista de todos os resultados de qualidade do ar para o local consultado.

DominantPollutant

Tipo de poluente. Observe que mais podem ser adicionados a qualquer momento.

Nome	Tipo	Description
Carbon Monoxide	string	Monóxido de carbono ("CO")
Nitrogen Dioxide	string	Dióxido de nitrogênio ("NO2")
Ozone	string	Ozônio ("O3")
Particulate Matter 10	string	Particular matéria 10 ("PM10")
Particulate Matter 2.5	string	Material particulado 2.5 ("PM2.5")
Sulfur Dioxide	string	Dióxido de enxofre ("SO2")

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

Pollutant

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

Nome	Tipo	Description
concentration	WeatherUnit	Um objeto que contém o número de partículas poluentes por volume de ar.
globalIndex	number	Classificação internacionalmente normalizada da qualidade do ar em uma escala de 0 a 300 ou mais, com números mais altos representando pior qualidade do ar.
index	number	Classificação de qualidade do ar em um conjunto de dimensionamento por órgãos reguladores locais. As escalas podem variar amplamente 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. Observe que mais podem ser adicionados a qualquer momento.

PollutantType