Pular para o conteúdo

API da Halver

A API da Halver é a mesma que o painel usa. Com um token de API você automatiza o que faz no portal: contratar e reinstalar servidores, ligar e desligar, cadastrar chaves SSH, criar redes privadas e IPs elásticos, consultar faturas e abrir chamados. Ela foi feita para automação: chaves de idempotência, paginação por cursor, operações assíncronas com um contrato de espera e cabeçalhos de limite de uso.

  • Endereço base: https://dash.halver.com.br/api/v1
  • Autenticação: Authorization: Bearer sc_live_…, com um token criado em Desenvolvedores › Tokens de API no portal.
  • Formato: JSON em snake_case. Dinheiro em centavos de real, inteiros (89900 é R$ 899,00). Datas de calendário como AAAA-MM-DD; instantes em RFC 3339 (UTC). IDs são UUID.
  • Erros: application/problem+json (RFC 9457) com um code estável.
Janela do terminal
export HALVER_API_TOKEN=sc_live_... # guarde num cofre de segredos, nunca no código
curl https://dash.halver.com.br/api/v1/me \
-H "Authorization: Bearer $HALVER_API_TOKEN"

A referência da API tem uma página por operação, com o escopo do token, os parâmetros, o corpo, as respostas, os erros e exemplos em curl, Go e Python. Ela é gerada a cada publicação desta documentação a partir da mesma referência OpenAPI abaixo, que os testes da plataforma conferem contra o servidor.

A especificação OpenAPI 3 da API pública, só com as operações que um token pode chamar. Use para gerar um cliente (por exemplo com o oapi-codegen, em Go, ou o openapi-generator) ou importar num cliente HTTP.

As mudanças ficam no changelog.