Arely (Independent Publisher)
O Airly fornece dados hiper-locais precisos sobre a poluição do ar em sua comunidade. Este é o primeiro passo para entender os riscos à saúde e fazer melhorias.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Tomasz Poszytek |
| URL | https://aka.ms/poszytek |
| tomasz@poszytek.eu |
| Metadados do conector | |
|---|---|
| Publicador | Tomasz Poszytek |
| Site | https://airly.org/ |
| Política de privacidade | https://airly.org/en/terms-conditions/ |
| Categorias | Internet das Coisas; Estilo de vida e entretenimento |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Obter a instalação por ID |
A operação retorna metadados de instalação únicos, dados por InstallationId. |
| Obter instalações mais próximas |
O ponto de extremidade retorna a lista de instalações mais próximas de um determinado ponto, classificadas por distância até esse ponto. |
| Obter medidas disponíveis |
O ponto de extremidade retorna a lista de todos os tipos de medida com suporte na API, juntamente com seus nomes e unidades. |
| Obter medidas mais próximas |
O ponto de extremidade retorna medidas para uma instalação mais próxima de um determinado local. |
| Obter medidas para instalação |
O ponto de extremidade retorna medidas para instalação concreta fornecida por InstallationId. |
| Obter medidas para um ponto |
O ponto de extremidade retorna medidas para qualquer localização geográfica. Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). O valor retornado é uma média ponderada, com o peso inversamente proporcional à distância do sensor até o ponto determinado. |
| Obter índices disponíveis |
O ponto de extremidade retorna uma lista de todos os tipos de índice com suporte na API, juntamente com listas de níveis definidos por cada tipo de índice. |
Obter a instalação por ID
A operação retorna metadados de instalação únicos, dados por InstallationId.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Instalação
|
InstallationID | True | integer |
ID da única instalação para obter metadados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | integer |
Identificador de instalação exclusivo. Tendo InstallationId, você pode consultar medidas de uma instalação específica. |
|
Latitude
|
location.latitude | float |
Coordenadas de instalação – latitude. Localização exata do sensor no mapa. |
|
Longitude
|
location.longitude | float |
Coordenadas de instalação – longitude. Localização exata do sensor no mapa. |
|
ID da localização
|
locationId | integer |
Identificador de local exclusivo. |
|
País
|
address.country | string |
País de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
City
|
address.city | string |
Cidade de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
Rua
|
address.street | string |
Rua de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
Número
|
address.number | string |
Número da rua de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
Endereço de exibição 1
|
address.displayAddress1 | string |
Campo extra que descreve o endereço, por exemplo, nome ou número da escola. Campo opcional. |
|
Endereço de exibição 2
|
address.displayAddress2 | string |
Campo extra que descreve o endereço, por exemplo, nome ou número da escola. Campo opcional. |
|
Elevation
|
elevation | float |
Altitude na qual o dispositivo está instalado; metros acima do nível médio do mar (mamsl). |
|
Arejado
|
airly | boolean |
Sinalizador que indica se essa instalação é um dispositivo Airly ou não; Por exemplo, as estações GIOŚ são sinalizadas como falsas. |
|
ID
|
sponsor.id | integer |
Identificador de patrocinador. |
|
Nome
|
sponsor.name | string |
Nome do patrocinador desta instalação. |
|
Description
|
sponsor.description | string |
Descrição adicional do patrocinador desta instalação. |
|
Logotipo
|
sponsor.logo | string |
Url apontando para o logotipo do patrocinador (imagem jpg). |
|
Link
|
sponsor.link | string |
Url apontando para o site do patrocinador. |
Obter instalações mais próximas
O ponto de extremidade retorna a lista de instalações mais próximas de um determinado ponto, classificadas por distância até esse ponto.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Latitude
|
lat | True | float |
Latitude como grau decimal, por exemplo, 50,062006. |
|
Longitude
|
lng | True | float |
Longitude como grau decimal, por exemplo, 19,940984. |
|
Distância máxima (KM)
|
maxDistanceKM | float |
Valor padrão 3.0. Todas as instalações retornadas devem estar localizadas dentro desse limite a partir do ponto determinado (em km). Valor negativo significa que não há limite. |
|
|
Resultados máximos retornados
|
maxResults | integer |
Valor padrão 1. Número máximo de instalações a serem retornadas. Valor negativo significa que não há limite |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | integer |
Identificador de instalação exclusivo. Tendo InstallationId, você pode consultar medidas de uma instalação específica. |
|
Latitude
|
location.latitude | float |
Coordenadas de instalação – latitude. Localização exata do sensor no mapa. |
|
Longitude
|
location.longitude | float |
Coordenadas de instalação – longitude. Localização exata do sensor no mapa. |
|
ID da localização
|
locationId | integer |
Identificador de local exclusivo. |
|
País
|
address.country | string |
País de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
City
|
address.city | string |
Cidade de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
Rua
|
address.street | string |
Rua de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
Número
|
address.number | string |
Número da rua de instalação. O atributo é opcional, pode estar vazio ou nulo. |
|
Endereço de exibição 1
|
address.displayAddress1 | string |
Campo extra que descreve o endereço, por exemplo, nome ou número da escola. Campo opcional. |
|
Endereço de exibição 2
|
address.displayAddress2 | string |
Campo extra que descreve o endereço, por exemplo, nome ou número da escola. Campo opcional. |
|
Elevation
|
elevation | float |
Altitude na qual o dispositivo está instalado; metros acima do nível médio do mar (mamsl). |
|
Arejado
|
airly | boolean |
Sinalizador que indica se essa instalação é um dispositivo Airly ou não; Por exemplo, as estações GIOŚ são sinalizadas como falsas. |
|
ID
|
sponsor.id | integer |
Identificador de patrocinador. |
|
Nome
|
sponsor.name | string |
Nome do patrocinador desta instalação. |
|
Description
|
sponsor.description | string |
Descrição adicional do patrocinador desta instalação. |
|
Logotipo
|
sponsor.logo | string |
Url apontando para o logotipo do patrocinador (imagem jpg). |
|
Link
|
sponsor.link | string |
Url apontando para o site do patrocinador. |
Obter medidas disponíveis
O ponto de extremidade retorna a lista de todos os tipos de medida com suporte na API, juntamente com seus nomes e unidades.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
Accept-Language | string |
Idioma no qual as descrições de texto devem ser retornadas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Nome
|
name | string |
Nome desse tipo de medida, por exemplo, PM10. |
|
Etiqueta
|
label | string |
Nome descritivo desse tipo de medida (campo traduzido). |
|
Unidade
|
unit | string |
Unidade desse tipo de medida, por exemplo, μg/m3. |
Obter medidas mais próximas
O ponto de extremidade retorna medidas para uma instalação mais próxima de um determinado local.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Latitude
|
lat | True | number |
Latitude como grau decimal, por exemplo, 50,062006. |
|
Longitude
|
lng | True | number |
Longitude como grau decimal, por exemplo, 19,940984. |
|
Distância máxima (KM)
|
maxDistanceKM | float |
A instalação pesquisada deve estar localizada dentro desse limite do ponto determinado (em km). Valor negativo significa que não há limite. |
|
|
Tipo de índice
|
indexType | string |
Seleciona o tipo do índice que deve ser calculado e retornado em resposta. |
|
|
Linguagem
|
Accept-Language | string |
Idioma no qual as descrições de texto devem ser retornadas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
De DateTime – atual
|
current.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime – atual
|
current.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
current.values | array of object |
Valores – atuais. |
|
Nome da medida – atual
|
current.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – atual
|
current.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
current.indexes | array of object |
Índices – atual. |
|
Nome do índice – atual
|
current.indexes.name | string |
Nome do índice (por exemplo, CAQI ou PIJP). |
|
Valor do índice – atual
|
current.indexes.value | float |
Valor numérico do índice calculado. |
|
Nível – atual
|
current.indexes.level | string |
Nível discreto do índice (por exemplo, ALTA ou BAIXA etc.). |
|
Descrição – atual
|
current.indexes.description | string |
Descrição do nível de índice. O texto traduzido e retornado em um idioma de acordo com Accept-Language cabeçalho de solicitação. |
|
Conselhos – atual
|
current.indexes.advice | string |
Texto adicional com conselhos sobre o nível de índice atual. O texto traduzido e retornado em um idioma de acordo com Accept-Language cabeçalho de solicitação. |
|
Cor – atual
|
current.indexes.color | string |
Cor que representa o nível de índice em uma forma de trigêmeo RGB hexadecimal (por exemplo, #D1CF1E). |
|
standards
|
current.standards | array of object |
Padrões – atuais. |
|
Nome padrão - atual
|
current.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - atual
|
current.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – atual
|
current.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem – atual
|
current.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - atual
|
current.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
histórico
|
history | array of object |
Entradas históricas. |
|
De DateTime – histórico
|
history.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime – histórico
|
history.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
history.values | array of object |
Valores – histórico. |
|
Nome da medida – histórico
|
history.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – histórico
|
history.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
history.indexes | array of object |
Índices – histórico. |
|
Nome padrão - histórico
|
history.indexes.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - histórico
|
history.indexes.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – histórico
|
history.indexes.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - histórico
|
history.indexes.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - histórico
|
history.indexes.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
standards
|
history.standards | array of object |
Padrões - histórico. |
|
Nome padrão - histórico
|
history.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - histórico
|
history.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – histórico
|
history.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - histórico
|
history.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - histórico
|
history.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
previsão
|
forecast | array of object |
Previsão de entradas. |
|
De DateTime – previsão
|
forecast.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime - previsão
|
forecast.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
forecast.values | array of object |
Valores – previsão. |
|
Nome da medida – previsão
|
forecast.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – previsão
|
forecast.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
forecast.indexes | array of object |
Índices – previsão. |
|
Nome padrão - previsão
|
forecast.indexes.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - previsão
|
forecast.indexes.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – previsão
|
forecast.indexes.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - previsão
|
forecast.indexes.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - previsão
|
forecast.indexes.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
standards
|
forecast.standards | array of object |
Padrões - previsão. |
|
Nome padrão - previsão
|
forecast.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - previsão
|
forecast.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – previsão
|
forecast.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - previsão
|
forecast.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - previsão
|
forecast.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
Obter medidas para instalação
O ponto de extremidade retorna medidas para instalação concreta fornecida por InstallationId.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Instalação
|
installationId | True | integer |
Identificador de instalação para o qual as medidas são retornadas. |
|
Linguagem
|
Accept-Language | string |
Idioma no qual as descrições de texto devem ser retornadas. |
|
|
Tipo de índice
|
indexType | string |
Seleciona o tipo do índice que deve ser calculado e retornado em resposta. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
De DateTime – atual
|
current.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime – atual
|
current.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
current.values | array of object |
Valores – atuais. |
|
Nome da medida – atual
|
current.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – atual
|
current.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
current.indexes | array of object |
Índices – atual. |
|
Nome do índice – atual
|
current.indexes.name | string |
Nome do índice (por exemplo, CAQI ou PIJP). |
|
Valor do índice – atual
|
current.indexes.value | float |
Valor numérico do índice calculado. |
|
Nível – atual
|
current.indexes.level | string |
Nível discreto do índice (por exemplo, ALTA ou BAIXA etc.). |
|
Descrição – atual
|
current.indexes.description | string |
Descrição do nível de índice. O texto traduzido e retornado em um idioma de acordo com Accept-Language cabeçalho de solicitação. |
|
Conselhos – atual
|
current.indexes.advice | string |
Texto adicional com conselhos sobre o nível de índice atual. O texto traduzido e retornado em um idioma de acordo com Accept-Language cabeçalho de solicitação. |
|
Cor – atual
|
current.indexes.color | string |
Cor que representa o nível de índice em uma forma de trigêmeo RGB hexadecimal (por exemplo, #D1CF1E). |
|
standards
|
current.standards | array of object |
Padrões – atuais. |
|
Nome padrão - atual
|
current.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - atual
|
current.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – atual
|
current.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem – atual
|
current.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - atual
|
current.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
histórico
|
history | array of object |
Entradas históricas. |
|
De DateTime – histórico
|
history.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime – histórico
|
history.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
history.values | array of object |
Valores – histórico. |
|
Nome da medida – histórico
|
history.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – histórico
|
history.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
history.indexes | array of object |
Índices – histórico. |
|
Nome padrão - histórico
|
history.indexes.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - histórico
|
history.indexes.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – histórico
|
history.indexes.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - histórico
|
history.indexes.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - histórico
|
history.indexes.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
standards
|
history.standards | array of object |
Padrões - histórico. |
|
Nome padrão - histórico
|
history.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - histórico
|
history.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – histórico
|
history.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - histórico
|
history.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - histórico
|
history.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
previsão
|
forecast | array of object |
Previsão de entradas. |
|
De DateTime – previsão
|
forecast.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime - previsão
|
forecast.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
forecast.values | array of object |
Valores – previsão. |
|
Nome da medida – previsão
|
forecast.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – previsão
|
forecast.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
forecast.indexes | array of object |
Índices – previsão. |
|
Nome padrão - previsão
|
forecast.indexes.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - previsão
|
forecast.indexes.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – previsão
|
forecast.indexes.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - previsão
|
forecast.indexes.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - previsão
|
forecast.indexes.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
standards
|
forecast.standards | array of object |
Padrões - previsão. |
|
Nome padrão - previsão
|
forecast.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - previsão
|
forecast.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – previsão
|
forecast.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - previsão
|
forecast.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - previsão
|
forecast.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
Obter medidas para um ponto
O ponto de extremidade retorna medidas para qualquer localização geográfica. Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). O valor retornado é uma média ponderada, com o peso inversamente proporcional à distância do sensor até o ponto determinado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Latitude
|
lat | True | number |
Latitude como grau decimal, por exemplo, 50,062006. |
|
Longitude
|
lng | True | number |
Longitude como grau decimal, por exemplo, 19,940984. |
|
Tipo de índice
|
indexType | string |
Seleciona o tipo do índice que deve ser calculado e retornado em resposta. |
|
|
Linguagem
|
Accept-Language | string |
Idioma no qual as descrições de texto devem ser retornadas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
De DateTime – atual
|
current.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime – atual
|
current.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
current.values | array of object |
Valores – atuais. |
|
Nome da medida – atual
|
current.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – atual
|
current.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
current.indexes | array of object |
Índices – atual. |
|
Nome do índice – atual
|
current.indexes.name | string |
Nome do índice (por exemplo, CAQI ou PIJP). |
|
Valor do índice – atual
|
current.indexes.value | float |
Valor numérico do índice calculado. |
|
Nível – atual
|
current.indexes.level | string |
Nível discreto do índice (por exemplo, ALTA ou BAIXA etc.). |
|
Descrição – atual
|
current.indexes.description | string |
Descrição do nível de índice. O texto traduzido e retornado em um idioma de acordo com Accept-Language cabeçalho de solicitação. |
|
Conselhos – atual
|
current.indexes.advice | string |
Texto adicional com conselhos sobre o nível de índice atual. O texto traduzido e retornado em um idioma de acordo com Accept-Language cabeçalho de solicitação. |
|
Cor – atual
|
current.indexes.color | string |
Cor que representa o nível de índice em uma forma de trigêmeo RGB hexadecimal (por exemplo, #D1CF1E). |
|
standards
|
current.standards | array of object |
Padrões – atuais. |
|
Nome padrão - atual
|
current.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - atual
|
current.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – atual
|
current.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem – atual
|
current.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - atual
|
current.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
histórico
|
history | array of object |
Entradas históricas. |
|
De DateTime – histórico
|
history.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime – histórico
|
history.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
history.values | array of object |
Valores – histórico. |
|
Nome da medida – histórico
|
history.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – histórico
|
history.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
history.indexes | array of object |
Índices – histórico. |
|
Nome padrão - histórico
|
history.indexes.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - histórico
|
history.indexes.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – histórico
|
history.indexes.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - histórico
|
history.indexes.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - histórico
|
history.indexes.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
standards
|
history.standards | array of object |
Padrões - histórico. |
|
Nome padrão - histórico
|
history.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - histórico
|
history.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – histórico
|
history.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - histórico
|
history.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - histórico
|
history.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
previsão
|
forecast | array of object |
Previsão de entradas. |
|
De DateTime – previsão
|
forecast.fromDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de início da qual os dados nessa carga foram medidos e mediados. |
|
Till DateTime - previsão
|
forecast.tillDateTime | string |
ISO8601 carimbo de data/hora. Data e hora em UTC. O campo representa a hora de término para a qual os dados nessa carga foram medidos e mediados. |
|
values
|
forecast.values | array of object |
Valores – previsão. |
|
Nome da medida – previsão
|
forecast.values.name | string |
Nome (tipo) da medida fornecida; por exemplo, PM10. |
|
Valor da medida – previsão
|
forecast.values.value | float |
Valor medido do tipo de medida fornecido, por exemplo, concentração 25μg/m3. |
|
índices
|
forecast.indexes | array of object |
Índices – previsão. |
|
Nome padrão - previsão
|
forecast.indexes.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - previsão
|
forecast.indexes.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – previsão
|
forecast.indexes.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - previsão
|
forecast.indexes.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - previsão
|
forecast.indexes.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
|
standards
|
forecast.standards | array of object |
Padrões - previsão. |
|
Nome padrão - previsão
|
forecast.standards.name | string |
Nome desse padrão. Atualmente, há suporte apenas para os padrões da OMS. |
|
Poluente - previsão
|
forecast.standards.pollutant | string |
No momento, há suporte para o nome do poluente ao qual esse padrão se aplica, atualmente, apenas PM10 e PM25. |
|
Limite – previsão
|
forecast.standards.limit | float |
Determinado nível médio de concentração do poluente que não deve ser excedido durante determinado período de tempo; em outras palavras, esse é o valor para o qual a concentração de poluentes atinge 100% do limite. |
|
Porcentagem - previsão
|
forecast.standards.percent | float |
Valor de concentração de um determinado poluente expresso como um percentual dessa concentração no padrão/limite, por exemplo, para um padrão de 50μg/m3 de PM10, a concentração de 25μg/m3 é expressa como 50%. |
|
Média - previsão
|
forecast.standards.averaging | string |
Os valores de medida são interpolados pela média de medidas de sensores próximos (até 1,5km de distância do ponto determinado). |
Obter índices disponíveis
O ponto de extremidade retorna uma lista de todos os tipos de índice com suporte na API, juntamente com listas de níveis definidos por cada tipo de índice.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Nome do índice
|
name | string |
Nome do índice. |
|
níveis
|
levels | array of object |
Lista de níveis de índices disponíveis. |
|
Valor mínimo
|
levels.minValue | float |
Valor mínimo que o índice pode retornar para o nível especificado. |
|
Valor máximo
|
levels.maxValue | float |
Valor máximo que o índice pode retornar para o nível especificado. |
|
Valores
|
levels.values | string |
Valores que o índice pode retornar para o nível fornecido. |
|
Nome do nível
|
levels.level | string | |
|
Descrição de nível
|
levels.description | string | |
|
Cor
|
levels.color | string |
Cor que representa o nível de índice em uma forma de trigêmeo RGB hexadecimal (por exemplo, #D1CF1E). |