Chaves de API - Hyze Cloud

A chave de API é sua credencial de acesso à Hyze Cloud. Ela identifica seu workspace e autoriza cada requisição à API. Sem uma chave válida, nenhuma chamada é aceita.

Criar uma chave

Abra o dashboard

Entre em hyzecloud.com/dashboard.

Vá em Settings → Developer

O painel lista todas as chaves do workspace com nome, prefixo (hyze_…), última utilização e data de criação.

Clique em New key

Dê um nome que identifique o uso, como CI/CD Produção ou Scripts internos.

Copie e guarde o secret

A chave completa aparece apenas uma vez. Salve em um gerenciador de segredos ou variável de ambiente. Se você perder, será preciso revogá-la e criar outra.

Depois da criação, só o prefixo (hyze_…) fica visível no dashboard. Revogue imediatamente qualquer chave que possa ter vazado.

Autenticar uma requisição

Envie a chave no header Authorization com o esquema Bearer:

Authorization: Bearer hyze_sua_chave

curl https://api.hyzecloud.com/api/apps/ \
  -H "Authorization: Bearer $HYZE_API_KEY"

Com a SDK, passe a chave uma vez na inicialização:

import { HyzeCloud } from "@hyze-cloud/sdk";

const hyze = new HyzeCloud({ apiKey: process.env.HYZE_API_KEY });

A URL base da API é https://api.hyzecloud.com/api. O mesmo endpoint serve a todos os ambientes — o workspace é determinado pela chave usada na requisição.

Quando algo dá errado

Você recebe HTTP 401 quando:

A chave não é enviada no header Authorization
A chave está incorreta ou foi revogada
O header não segue o formato Bearer hyze_...

Boas práticas

Guarde chaves em variáveis de ambiente (HYZE_API_KEY), nunca no código ou no front-end
Use uma chave por ambiente ou automação (CI, local, tooling de produção)
Use nomes descritivos — eles aparecem na lista e ajudam a revogar a chave certa
Revogue chaves que não usa mais

Gerenciar chaves pela API

Além do dashboard, você pode criar, listar, atualizar e revogar chaves pelos endpoints de API keys.

Próximos passos

Quickstart

Valide sua chave com a primeira requisição.

Gerenciar secrets

Armazene chaves e configurações como variáveis de ambiente dos seus apps.

Workspaces

Entenda como as chaves se ligam ao seu workspace.

Rate limits

Limites da API e do proxy público.

​Criar uma chave

​Autenticar uma requisição

​Quando algo dá errado

​Boas práticas

​Gerenciar chaves pela API

​Próximos passos

Quickstart

Gerenciar secrets

Workspaces

Rate limits

Criar uma chave

Autenticar uma requisição

Quando algo dá errado

Boas práticas

Gerenciar chaves pela API

Próximos passos