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 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 o status geral da 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}

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 de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para `json` formato.
api-version	query	True	string	Número de versão da API do Azure Mapas.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgula composta por latitude seguida por longitude, por exemplo, "47,641268,-122,125679". As informações meteorológicas geralmente estão disponíveis para locais em terra, corpos d'água cercados por terra e áreas do oceano que estão a aproximadamente 50 milhas náuticas de uma costa.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem 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 de idiomas com suporte para obter detalhes.
pollutants	query		boolean	Valor booleano 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 da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Respostas

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

Segurança

AADToken

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

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 controlar o acesso em APIs e escopos específicos.

Anotações

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

O Authorization URL é específico para a instância de nuvem pública do Azure. 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 do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do 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 a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.

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

Tipo: apiKey
Em: query

SAS Token

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

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Get Current Air Quality

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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 horário específico.
AirQualityResult	Esse objeto é retornado de uma chamada bem-sucedida Get Air Quality.
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 `json` formato.
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érico associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidades. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.
WeatherUnit	Valor específico de uma determinada unidade relacionada ao clima.

AirQuality

Objeto

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

Nome	Tipo	Description
category	string	Descrição da qualidade do ar com uma palavra na língua solicitada. Por exemplo, "Excelente".
categoryColor	string	Uma cor única correspondente à categoria deste resultado de qualidade do ar.
dateTime	string (date-time)	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 da qualidade do ar no idioma solicitado.
dominantPollutant	DominantPollutant	O poluente com maior concentração.
globalIndex	number (float)	Classificação de qualidade do ar normalizada internacionalmente em uma escala de 0 a 300 ou mais, com números mais altos representando pior qualidade do ar.
index	number (float)	Classificação da qualidade do ar em uma escala definida pelos órgãos reguladores locais. As escalas podem variar muito com base na localização. Veja a Wikipedia para mais informações.
pollutants	Pollutant[]	Informações sobre poluentes individuais.

AirQualityResult

Objeto

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

Nome	Tipo	Description
nextLink	string	É 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 da qualidade do ar para o local consultado.

DominantPollutant

Enumeração

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

Valor	Description
Carbon Monoxide	Monóxido de carbono ("CO")
Nitrogen Dioxide	Dióxido de azoto ("NO2")
Ozone	Ozônio ("O3")
Particulate Matter 10	Material particulado 10 ("PM10")
Particulate Matter 2.5	Material particulado 2,5 ("PM2,5")
Sulfur Dioxide	Dióxido de enxofre ("SO2")

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JsonFormat

Enumeração

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

Valor	Description
json	o formato de intercâmbio de dados de notação de objeto JavaScript

Pollutant

Objeto

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

Nome	Tipo	Description
concentration	WeatherUnit	Um objeto contendo o número de partículas poluentes por volume de ar.
globalIndex	number (float)	Classificação de qualidade do ar normalizada internacionalmente em uma escala de 0 a 300 ou mais, com números mais altos representando pior qualidade do ar.
index	number (float)	Classificação da qualidade do ar em uma escala definida pelos órgãos reguladores locais. As escalas podem variar muito com base na localização. Veja a Wikipedia para 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

Enumeração

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

Valor	Description
CO	Monóxido de carbono ("CO")
NO2	Dióxido de azoto ("NO2")
O3	Ozônio ("O3")
PM10	Material particulado 10 ("PM10")
PM2.5	Material particulado 2,5 ("PM2,5")
SO2	Dióxido de enxofre ("SO2")

UnitType

Enumeração

Valor de ID numérico associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidades. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.

Valor	Description
0	pés
1	polegadas
10	metros por segundo
11	hectoPascals
12	polegadas de mercúrio
13	quiloPascal
14	milibares
15	milímetros de mercúrio
16	libras por polegada quadrada
17	célsius
18	Fahrenheit
19	kelvin
2	milhas
20	porcentagem
21	flutuar
22	número inteiro
3	milímetro
31	MicrogramasPorMetroCúbicoDeAr
4	centímetro
5	metro
6	quilômetro
7	quilômetros por hora
8	nós
9	milhas por hora

WeatherUnit

Objeto

Valor específico de uma determinada unidade relacionada ao clima.

Nome	Tipo	Description
unit	string	Tipo de unidade para o valor retornado.
unitType	UnitType (int32)	Valor de ID numérico associado ao tipo de unidade que está sendo exibida. Pode ser usado para tradução de unidades. Consulte Serviços meteorológicos no Azure Mapas para obter detalhes.
value	number (float)	Valor arredondado.

Compartilhar via

Weather - Get Current Air Quality

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AADToken

Anotações

Escopos

subscription-key

SAS Token

Exemplos

Get Current Air Quality

Solicitação de exemplo

Resposta de exemplo

Definições

AirQuality

AirQualityResult

DominantPollutant

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JsonFormat

Pollutant

PollutantType

UnitType

WeatherUnit