Weather - Get Current Air Quality

Referência

Serviço:: Maps

Versão da API:: 1.1

Use para obter informações atualizadas sobre a qualidade do ar que incluam riscos potenciais e precauções sugeridas.

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

Com parâmetros opcionais:

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 desejado da resposta. Apenas `json` formato é suportado.
api-version	query	True	string	Número da versão da API do Azure Maps.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679". As informações meteorológicas estão geralmente disponíveis para locais em terra, corpos de água cercados por terra e áreas do oceano que estão a aproximadamente 50 milhas náuticas de uma costa.
language	query		string	Idioma em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 de idiomas suportados para obter detalhes.
pollutants	query		boolean	Valor booleano que retorna informações detalhadas sobre cada poluente. Por padrão, é True.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

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

Segurança

AADToken

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

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

Observações

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

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

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

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: query

SAS Token

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

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Get Current Air Quality

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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 num local específico e num momento específico.
AirQualityResult	Este objeto é retornado de uma chamada Get Air Quality bem-sucedida.
DominantPollutant	Tipo de poluente. Por favor, note que mais podem ser adicionados a qualquer momento.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JsonFormat	Formato desejado da resposta. Apenas `json` formato é suportado.
Pollutant	Informações detalhadas sobre um poluente individual. Não retornado se `pollutants`=false.
PollutantType	Tipo de poluente. Por favor, note que mais podem ser adicionados a qualquer momento.
UnitType	Valor de ID numérico associado ao tipo de unidade que está sendo exibido. Pode ser usado para tradução de unidades. Consulte serviços meteorológicos no Azure Maps para obter detalhes.
WeatherUnit	Valor específico de uma dada unidade relacionado com o clima.

AirQuality

Informações sobre a qualidade do ar num local específico e num momento específico.

Name	Tipo	Description
category	string	Descrição em uma palavra da qualidade do ar na língua solicitada. Por exemplo, "Excelente".
categoryColor	string	Uma cor única correspondente à categoria deste 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 desta qualidade do ar resulta na língua solicitada.
dominantPollutant	DominantPollutant	O poluente com maior concentração.
globalIndex	number	Classificação da qualidade do ar normalizada internacionalmente em uma escala de 0 a 300 e acima, com números mais altos representando pior qualidade do ar.
index	number	Classificação da qualidade do ar numa escala definida pelas entidades reguladoras locais. As escalas podem variar muito de acordo com a localização. Veja da Wikipédia para mais informações.
pollutants	Pollutant[]	Informações sobre poluentes individuais.

AirQualityResult

Este objeto é retornado de uma chamada Get Air Quality bem-sucedida.

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

DominantPollutant

Tipo de poluente. Por favor, note que mais podem ser adicionados a qualquer momento.

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 em suspensão 10 ("PM10")
Particulate Matter 2.5	string	Partículas em suspensão 2.5 ("PM2.5")
Sulfur Dioxide	string	Dióxido de enxofre ("SO2")

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

Name	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.

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 em uma escala de 0 a 300 e acima, com números mais altos representando pior qualidade do ar.
index	number	Classificação da qualidade do ar numa escala definida pelas entidades reguladoras locais. As escalas podem variar muito de acordo com a localização. Veja da Wikipédia para mais informações.
name	string	O nome do poluente em inglês.
type	PollutantType	Tipo de poluente. Por favor, note que mais podem ser adicionados a qualquer momento.

PollutantType