Chave de Integração

Siga este passo a passo para criar a sua chave de API e começar a integrar os serviços à sua aplicação.

Uma chave de integração é um identificador único que permite à sua aplicação consultar as APIs da HG Brasil. Ela funciona como uma senha de acesso que autentica suas requisições, garantindo que apenas usuários autorizados possam utilizar os dados. Cada chave é associada a uma conta e possui limites de uso, que podem variar conforme o plano escolhido.

Com a chave em mãos, você poderá integrar recursos como previsão do tempo, cotações financeiras e geolocalização por IP em sua aplicação.

Guarde sua chave em segurança e nunca a divulgue publicamente.
Caso suspeite de uso indevido, atualize-a imediatamente através do Console.

Entre no Console

Acesse o Console e entre com as suas credenciais, ou faça um cadastro caso ainda não seja membro.

Acessar o Console

Acesse o menu de chaves

No menu, selecione a opção Chaves e clique no botão Criar nova chave.

Criar chave

Crie uma chave

Preencha os seguintes campos:

  • Nome da sua aplicação:
    Informe o nome do seu projeto ou aplicação. Este nome servirá para identificar a chave no painel de controle.
  • Tipo de chave:
    Selecione o tipo de chave que melhor se adequa à sua necessidade:
    • Chave para uso exposto:
      Destinada a aplicações client-side, como aquelas que utilizam JavaScript diretamente no navegador. Essa chave pode ficar exposta, mas deve ser utilizada apenas em ambientes onde o domínio esteja previamente configurado.
    • Chave para uso interno:
      Indicada para integrações no lado do servidor ou aplicativos mobile, onde a chave permanece protegida e não é exposta publicamente. Chaves internas podem ser utilizadas para testes em ambientes locais como localhost ou 127.0.0.1, não sendo necessário informar o domínio.
  • Domínio:
    Este campo é obrigatório para chaves de uso exposto. Informe o domínio do seu site. O sistema utilizará esta informação para validar as requisições, garantindo que a chave seja utilizada somente a partir do ambiente autorizado.

Ao salvar, Sua nova chave será exibida na tela. Copie-a e armazene em um local seguro.

Configurando sua aplicação

Vamos supor que a chave gerada seja suachave. Você deverá informá-la no parâmetro key na URL.

GET
https://api.hgbrasil.com/weather?key=suachave

Validação da chave

Todas as respostas da API incluem um campo valid_key que indica se a chave utilizada é válida:

{
  "by": "default",
  "valid_key": true,

  "results": {
    // ...
  }
}

O campo valid_key retornará true se chave é válida e está funcionando corretamente ou false caso a chave seja inválida ou exista algum problema na configuração.

Se valid_key for false, verifique se:

  • A chave foi informada corretamente;
  • O domínio está configurado (para chaves expostas);
  • A chave não foi desativada ou removida.