Weather - Get Daily Indices
Use quando quiser saber se as condições climáticas são ideais para uma atividade específica, como atividades esportivas ao ar livre, construção ou agricultura (os resultados incluem informações de umidade do solo).
A Get Daily Indices
API é uma solicitação HTTP GET
que retorna valores de índice que fornecem diretrizes para ajudar no planejamento de atividades futuras. Por exemplo, um aplicativo móvel de integridade pode notificar os usuários de que hoje é um bom tempo para correr ou para outras atividades ao ar livre, como jogar golfe ou empinar pipa. As lojas de varejo podem otimizar suas campanhas de marketing digital com base nos valores de índice previstos. O serviço retorna em índices diários valores para atuais e próximos 5, 10 e 15 dias a partir do dia atual.
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query={query}&language={language}&duration={duration}&indexId={indexId}&indexGroupId={indexGroupId}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato desejado da resposta. Há suporte apenas para o formato |
|
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". |
duration
|
query |
integer |
Especifica quantos dias os índices diários são retornados. Por padrão, os dados de índices do dia atual serão retornados. Ao solicitar dados de índices futuros, o dia atual é incluído na resposta como dia 1. Os valores disponíveis são
|
|
index
|
query |
integer |
Identificador de grupo de índice numérico que pode ser usado para restringir os resultados retornados ao subconjunto correspondente de índices (grupo de índices). Não é possível emparelhar com |
|
index
|
query |
integer |
Identificador de índice numérico que pode ser usado para restringir os resultados retornados ao tipo de índice correspondente. Não é possível emparelhar com |
|
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 Idiomas com suporte para obter detalhes. |
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 |
OK |
|
Other Status Codes |
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
Successfully retrieve daily indices values from current day
Sample Request
GET https://atlas.microsoft.com/weather/indices/daily/json?api-version=1.1&query=43.84745,-79.37849&indexGroupId=11
Sample Response
{
"results": [
{
"indexName": "Running Forecast",
"indexId": 1,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.2,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is an excellent day for outdoor running!"
},
{
"indexName": "Jogging Forecast",
"indexId": 2,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.4,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for jogging outdoors!"
},
{
"indexName": "Hiking Forecast",
"indexId": 3,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.8,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for hiking!"
},
{
"indexName": "Bicycling Forecast",
"indexId": 4,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.9,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for bicycling outdoors!"
},
{
"indexName": "Golf Weather Forecast",
"indexId": 5,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 10,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great day for golf."
},
{
"indexName": "Tennis Forecast",
"indexId": 6,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.2,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is an excellent day for playing tennis!"
},
{
"indexName": "Skateboarding Forecast",
"indexId": 7,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.9,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is an excellent day for skateboarding!"
},
{
"indexName": "Outdoor Concert Forecast",
"indexId": 8,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.7,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "Conditions are excellent for attending an outdoor concert!"
},
{
"indexName": "Kite Flying Forecast",
"indexId": 9,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.5,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditions are very good today for kite-flying."
},
{
"indexName": "Beach & Pool Forecast",
"indexId": 10,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.6,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditons will be very good for a visit to the beach or pool."
},
{
"indexName": "Sailing Forecast",
"indexId": 11,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.3,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditions will be very good for sailing."
},
{
"indexName": "Stargazing Forecast",
"indexId": 12,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.5,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great night to be stargazing!"
},
{
"indexName": "Fishing Forecast",
"indexId": 13,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 3.5,
"category": "Fair",
"categoryValue": 2,
"ascending": true,
"description": "Expect only fair conditions for fishing."
},
{
"indexName": "Ski Weather Forecast",
"indexId": 15,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 0,
"category": "Poor",
"categoryValue": 1,
"ascending": true,
"description": "Expect poor conditions for skiing."
},
{
"indexName": "Mosquito Activity Forecast",
"indexId": 17,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 7,
"category": "Very High",
"categoryValue": 4,
"ascending": true,
"description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly."
},
{
"indexName": "Hunting Forecast",
"indexId": 20,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 4.5,
"category": "Fair",
"categoryValue": 2,
"ascending": true,
"description": "Expect only fair conditions for hunting."
},
{
"indexName": "Outdoor Barbecue",
"indexId": 24,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.8,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great day for an outdoor barbecue!"
},
{
"indexName": "Lawn Mowing Forecast",
"indexId": 28,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 9.6,
"category": "Excellent",
"categoryValue": 5,
"ascending": true,
"description": "This is a great day for lawn mowing!"
},
{
"indexName": "Outdoor Activity Forecast",
"indexId": 29,
"dateTime": "2020-07-14T07:00:00-04:00",
"value": 8.7,
"category": "Very Good",
"categoryValue": 4,
"ascending": true,
"description": "Conditions will be very good for outdoor activities."
}
]
}
Definições
Nome | Description |
---|---|
Daily |
Informações sobre um índice diário. |
Daily |
Esse objeto é retornado de uma chamada get daily indices bem-sucedida. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Json |
Formato desejado da resposta. Há suporte apenas para o formato |
DailyIndex
Informações sobre um índice diário.
Nome | Tipo | Description |
---|---|---|
ascending |
boolean |
Descreve a direção do |
category |
string |
Descrição textual para |
categoryValue |
integer |
Nível em que o valor do índice se enquadra, representado por um inteiro. Esse valor pode ser de 1 a 5 e deve ser usado em combinação com o |
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 que pode ser usada para fins de exibição para resumir o valor e a categoria do índice. Por exemplo, quando o valor do índice de Atrasos de Voo for muito bom, a descrição será "As condições são excelentes para voar!". |
indexId |
integer |
ID numérica usada para identificar o índice específico. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes e para ver as IDs de índice com suporte. Por exemplo, a ID de índice pode dar suporte a cenários de visualização de interface do usuário. |
indexName |
string |
Nome do índice, por exemplo, "Construção", "Atividade ao ar livre", "Atrasos de voo". |
value |
number |
Valor do índice. Varia de 0,0 a 10,0. Consulte Serviços meteorológicos em Azure Mapas para obter detalhes e para ver os intervalos com suporte. |
DailyIndicesResult
Esse objeto é retornado de uma chamada get daily indices bem-sucedida.
Nome | Tipo | Description |
---|---|---|
results |
Uma lista de todos os índices diários para o local consultado. |
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 |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
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 |