Quickstart

Este guia leva você de uma conta nova no dashboard até uma requisição autenticada funcionando. Se ela retornar seus apps, sua autenticação está correta — e qualquer integração seguinte (CI/CD, scripts, backend) vai funcionar do mesmo jeito.

Pré-requisitos

Uma conta Hyze Cloud (cadastre-se)
Uma API key (começa com hyze_) — se ainda não tem, siga o guia de chaves de API

A URL base da API é https://api.hyzecloud.com/api. Mantenha esse prefixo em toda requisição.

Criar a API key

Abra o dashboard

Acesse hyzecloud.com/dashboard e faça login.

Navegue até API Keys

Vá em Settings → Developer e clique em New key.

Copie a chave

Ela começa com hyze_. Copie — a chave completa aparece só uma vez.

Fazer a primeira requisição

export HYZE_API_KEY="hyze_sua_chave"

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

Uma lista JSON dos apps do seu workspace significa que a autenticação está ok.

Com a SDK

npm install @hyzecloud/sdk

import { HyzeCloud } from "@hyzecloud/sdk";

const hyze = new HyzeCloud({ apiKey: process.env.HYZE_API_KEY });
const { apps } = await hyze.apps.list();
console.log(apps);

Se algo der errado

401 Unauthorized

A chave não foi enviada, está incorreta/revogada, ou o header não segue o formato Bearer hyze_.... Confira o valor de HYZE_API_KEY no seu shell com echo $HYZE_API_KEY.

404 Not Found

Você provavelmente esqueceu o prefixo /api na URL base.

429 Too Many Requests

Rate limit da API. Respeite o header Retry-After e tente de novo após os segundos indicados.

Deploy de app

Publicar via ZIP ou GitHub.

SDK Node.js

Guia completo da SDK.

Provisionar database

Criar PostgreSQL, MySQL, MongoDB ou Redis.

Referência da API

Todos os endpoints.

Última modificação em 1 de setembro de 2026

Comece aqui

Pré-requisitos

Criar a API key

Fazer a primeira requisição

Com a SDK

Se algo der errado

Próximo

Deploy de app

SDK Node.js

Provisionar database

Referência da API

​Pré-requisitos

​Criar a API key

​Fazer a primeira requisição

​Com a SDK

​Se algo der errado

​Próximo

Deploy de app

SDK Node.js

Provisionar database

Referência da API

Pré-requisitos

Criar a API key

Fazer a primeira requisição

Com a SDK

Se algo der errado

Próximo