Skip to main content
A chave de API é sua credencial de acesso à Hyze Cloud. Ela identifica seu workspace e autoriza cada requisição enviada para a nossa API. Sem uma chave válida, nenhuma chamada será aceita.

O que você pode fazer com suas chaves

As chaves de API são gerenciadas diretamente pelo dashboard. Com elas, você pode:
  • Ver todas as chaves ativas do seu workspace
  • Criar novas chaves para diferentes projetos (CI/CD, ambientes internos, automações)
  • Revogar chaves comprometidas ou que não estão mais em uso

Onde encontrar suas chaves

Todas as chaves ficam em Settings → Developer no Dashboard. O painel mostra o nome, o prefixo (hyze_…), a última utilização e a data de criação de cada chave.

Erro de autenticação (401)

Você receberá um HTTP 401 quando:
  • A chave não for enviada no header Authorization
  • A chave estiver incorreta ou tiver sido revogada
  • O header não seguir o formato Bearer hyze_...

Como a autenticação funciona

Toda requisição para a API da Hyze Cloud deve enviar a chave no header Authorization usando o esquema Bearer.
Exemplo real:
A URL base da API é https://api.hyzecloud.com/api. Mantenha esse prefixo em todas as requisições.

Boas práticas de segurança

Proteja suas chaves

  • Armazene suas chaves em variáveis de ambiente (ex.: HYZE_API_KEY)
  • Nunca publique sua chave em repositórios, logs ou grupos públicos
  • A Hyze Cloud nunca solicitará sua chave
  • Revogue imediatamente qualquer chave que possa ter vazado
  • Use nomes descritivos para identificar o uso de cada chave (“CI/CD Produção”, “Scripts internos”)

Como criar uma chave de API

Siga os passos abaixo no dashboard:
1

Acesse o Dashboard

Entre em hyzecloud.com/dashboard com sua conta da Hyze Cloud.

Login

Se você ainda não tem conta, crie uma gratuitamente em hyzecloud.com/dashboard.
2

Abra Settings → Developer

No menu lateral, clique em Settings e selecione a aba Developer.

Painel de API keys

O painel lista todas as chaves do seu workspace com nome, prefixo, última utilização e data de criação.
3

Clique em New key

No canto superior direito do painel de API keys, clique em New key para abrir o formulário de criação.
4

Dê um nome à chave

Use um nome claro que identifique o uso da chave, como “CI/CD Produção” ou “Scripts internos”. Esse nome aparece na lista de chaves e ajuda a revogar a chave certa no futuro.
5

Copie a chave gerada

A chave completa aparece apenas uma vez no formulário. Copie e salve em um gerenciador de segredos (variável de ambiente, vault, etc.).
A chave completa é exibida somente no momento da criação. Depois disso, apenas o prefixo (hyze_…) fica visível no Dashboard. Se você perder a chave, será preciso revogá-la e criar uma nova.

Faça sua primeira requisição

Depois de criar a chave, você já pode enviar requisições autenticadas:
Para guardar a chave em uma variável de ambiente:

Nota importante

O mesmo endpoint api.hyzecloud.com é usado para todos os ambientes. O workspace é determinado automaticamente pela chave de API utilizada na requisição.

Próximos passos

Referência de API keys

Criar, listar, atualizar e revogar chaves via API.

Gerenciar secrets

Armazene chaves e configurações como variáveis de ambiente dos seus apps.
Última modificação em 17 de julho de 2026