Configurar a API Time Zone

Este documento descreve as etapas necessárias para começar a usar a API de Fuso Horário.

Pré-requisitos

Este procedimento orienta você na configuração de uma conta do Google Cloud e de um projeto na nuvem com o faturamento ativado. Você também precisa saber como é feita a cobrança pelo uso da API de fuso horário.

  1. Consulte o faturamento e o custo de uso em Uso e faturamento da API Time Zone.

  2. Verifique se você tem uma Conta do Google Cloud.

    Faça login no console do Google Cloud

  3. Verifique se você tem um projeto do Google Cloud com o faturamento ativado.

    Acessar a página "Faturamento"
    1. Selecione o projeto para abrir a página Faturamento.

    2. Na página Faturamento:

      • Se o faturamento já estiver ativado para o projeto selecionado e você tiver apenas uma conta de faturamento, a página Faturamento será aberta.
      • Se você tiver várias contas de faturamento, selecione Acessar a conta de faturamento vinculada para ver os detalhes da conta de faturamento associada ao projeto.
      • Se uma conta de faturamento existir, mas não estiver associada ao projeto, será solicitado que você vincule uma conta de faturamento ao projeto.
      • Se não houver uma conta de faturamento ou se você quiser criar uma nova, selecione Gerenciar contas de faturamento para criar uma nova conta de faturamento. Para mais informações, consulte Criar uma nova conta do Cloud Billing de autoatendimento.

Ativar a API

Antes de usar a API Time Zone, use o console do Google Cloud ou o comando gcloud para ativá-la no seu projeto do Google Cloud.

Para ativar a API:

Console

  1. Abra a página do produto no console do Google Cloud:

    Ativar a API de Fuso Horário

  2. Clique no botão Ativar.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "timezone-backend.googleapis.com"

Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

Receber uma chave de API para usar com a API Fuso Horário

Para proteger os produtos da Plataforma Google Maps contra uso não autorizado, as chamadas de API precisam incluir uma chave de API.

Uma chave de API é uma string alfanumérica exclusiva que associa sua conta do Cloud Billing e o projeto na nuvem do Google Cloud à solicitação que seu aplicativo faz a uma API ou um SDK da Plataforma Google Maps. Para criar uma nova chave ou adicionar uma API ou um SDK a uma chave, siga estas instruções.

Console

  1. Acesse a página Plataforma Google Maps > Chaves e credenciais.

    Acessar a página Chaves e credenciais

  2. Se solicitado, selecione o projeto.

  3. Escolha uma destas opções:

    • Crie uma nova chave:

      1. Clique em Criar credenciais > Chave de API.
      2. No painel Criar chave de API, abra a lista Selecionar restrições de API.
      3. Limpe as APIs que essa chave não precisa e verifique se a API de fuso horário permanece selecionada.
      4. Clique em Criar. O painel mostra sua nova chave de API.

    • Usar uma chave atual:

      1. Clique no nome da chave.
      2. Na lista Selecionar restrições de API, escolha API de fuso horário.
      3. Clique em Salvar.

    Selecionar uma API aqui não a ativa. Verifique se a API de fuso horário está ativada na página da biblioteca de APIs.

  4. Para ver a string da chave mais tarde, acesse a página Chaves e credenciais e clique em Mostrar chave.

Se o console estiver diferente do que é mostrado nestas etapas, consulte Criar uma chave de API e Adicionar restrições de API na documentação do Google Cloud.

gcloud

Substitua PROJECT_ID pelo ID do projeto nos comandos a seguir.

  • Crie uma nova chave: execute o comando a seguir e substitua DISPLAY_NAME por um nome para a chave. 

    gcloud services api-keys create \
    --project="PROJECT_ID" \
    --display-name="DISPLAY_NAME" \
    --api-target=service=timezone-backend.googleapis.com

    Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

  • Usar uma chave atual: execute o comando a seguir e substitua KEY_ID pelo ID da chave. A flag --append mantém as APIs que a chave já permite. Sem ele, o comando as substitui.

    gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=timezone-backend.googleapis.com

    Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

    O ID da chave não é a string de chave nem o nome de exibição. Para encontrá-lo, execute gcloud services api-keys list --project="PROJECT_ID". O ID é a última parte do campo name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Para ver a string de chave, execute gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Fazer uma solicitação de API

Faça uma solicitação de API Time Zone para retornar uma resposta JSON com as informações de fuso horário de Nevada, EUA. O carimbo de data/hora está definido como 5 de dezembro de 2024. É preciso incluir a string alfanumérica da chave de API em todas as solicitações e usar HTTPS para solicitações que incluem a chave de API.

  1. Clique em API_KEY no código abaixo para inserir a string alfanumérica da chave:

    curl -L -X GET 'https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810%2C-119.6822510&timestamp=1733428634&key=YOUR_API_KEY'
  2. Clique no ícone de cópia no exemplo de código, Selecione o ícone de cópia., para copiar o comando curl.
  3. Cole o comando em uma janela do terminal e execute-o.

A resposta é um objeto JSON no formato:

{
   "dstOffset" : 0,
   "rawOffset" : -28800,
   "status" : "OK",
   "timeZoneId" : "America/Los_Angeles",
   "timeZoneName" : "Pacific Standard Time"
}

Aplicar restrições de chave de API

O Google recomenda que você restrinja as chaves de API limitando o uso somente às APIs e aos apps que precisam delas. Restringir chaves de API adiciona segurança ao seu aplicativo, protegendo-o contra solicitações não autorizadas. As chaves de API são compatíveis com dois tipos de restrições:

  • As restrições de API especificam quais SDKs e APIs podem ser chamados com a chave de API. O console e a CLI gcloud exigem pelo menos uma restrição de API quando você cria uma chave.
  • As restrições de aplicativo especificam quais sites, endereços IP ou apps podem usar uma chave de API.

Para mais informações sobre como aplicar restrições, consulte Restringir suas chaves de API.

A seguir

Agora que você ativou a API de fuso horário e fez uma solicitação bem-sucedida, consulte Solicitações e respostas de fuso horário para saber mais sobre como usar a API.