Ir para o conteúdo

-10% no seu primeiro mês-10% 1º mês

O que você quer hospedar?

Gira os seus servidores a partir das suas ferramentas

A API da área de cliente HelloServ abre os seus servidores de jogos, VPS e servidores dedicados aos seus scripts, à sua monitorização e aos seus painéis: estado em direto, arranque e paragem, reinstalação, faturas e encomendas de servidores pagas com o seu saldo.

terminal

$ curl https://panel.helloserv.fr/api/v1/services \
    -H "Authorization: Bearer $HELLOSERV_KEY"

{"data": [
  {"id": 48213, "name": "vps-prod-1", "type": "vps",
   "product": "vpsryzen", "status": "active",
   "primary_ip": "203.0.113.24",
   "actions": {"power": true, "reinstall": true}},
  {"id": 31877, "name": "survie-mc", "type": "game",
   "product": "minecraft", "status": "active",
   "primary_ip": "198.51.100.7",
   "actions": {"power": true, "reinstall": false}}
]}

As ações do painel, a partir do seu código

Uma API REST em JSON, sobre HTTPS. Cada chave só recebe as permissões que lhe der.

  • Listar os seus serviços, as suas características e os seus endereços IPGET /servicesLeitura
  • Ler o estado de um servidor em diretoGET /services/{id}/statusLeitura
  • Arrancar, reiniciar ou parar um servidorPOST /services/{id}/powerEnergia
  • Reinstalar um VPS ou um servidor dedicadoPOST /services/{id}/reinstallReinstalação
  • Descarregar as suas faturas em PDFGET /invoices/{number}/pdfLeitura
  • Encomendar um servidor de jogos ou um VPS com o seu saldoPOST /ordersPedidos

A documentação descreve também a conta e o saldo, o catálogo com os seus preços, o histórico de encomendas, os limites e os códigos de erro.

Ligue a API às ferramentas que já utiliza

Algumas linhas de script chegam para a maioria das utilizações. Nos exemplos, $API vale https://panel.helloserv.fr/api/v1 e $HELLOSERV_KEY contém a sua chave.

Monitorização e painéis

Mostre o estado dos seus servidores ao lado do resto da sua infraestrutura, no Grafana, no Uptime Kuma ou na sua ferramenta interna, e lance um alerta quando um deles parar.

supervision.sh

$ curl -s $API/services/48213/status \
    -H "Authorization: Bearer $HELLOSERV_KEY" | jq .data.power
"running"

Scripts, tarefas agendadas e implementações

Reinicie um servidor de jogos depois de atualizar os mods, reinstale um VPS de testes a partir da sua integração contínua ou pare um servidor durante a noite com uma tarefa agendada.

deploy.yml

- name: Restart the server after the update
  run: >
    curl -X POST
    https://panel.helloserv.fr/api/v1/services/31877/power
    -H "Authorization: Bearer ${{ secrets.HELLOSERV_KEY }}"
    -H "Content-Type: application/json"
    -d '{"action": "restart"}'

Revenda de servidores de jogos e VPS

A sua loja encomenda o servidor com o seu saldo, ao preço da área de cliente, e entrega-o ao seu cliente com o respetivo endereço IP. Os preços são definidos por si.

commande.sh

$ curl -X POST $API/orders \
    -H "Authorization: Bearer $HELLOSERV_KEY" \
    -H "Idempotency-Key: commande-1042" \
    -H "Content-Type: application/json" \
    -d '{"type": "minecraft", "offer_id": 2, "period": "monthly"}'

Agências e parques de servidores

Gira os servidores dos seus clientes a partir da sua ferramenta de exploração, com uma chave por projeto, e descarregue todos os meses as faturas em PDF para a sua contabilidade.

factures.sh

$ curl -s "$API/invoices?per_page=100" \
    -H "Authorization: Bearer $HELLOSERV_KEY"
$ curl -o INV-2026-001234.pdf \
    $API/invoices/INV-2026-001234/pdf \
    -H "Authorization: Bearer $HELLOSERV_KEY"

Uma chave por ferramenta, com as suas permissões e endereços

As chaves criam-se na área de cliente, em Meu perfil e depois Segurança. A criação pede a autenticação de dois fatores, e cada chave só é mostrada uma vez.

Formulário de criação de uma chave de API na área de cliente HelloServ, com as permissões Leitura, Energia, Reinstalação e Pedidos e o campo dos endereços IP autorizados
Criação de uma chave: um nome, as permissões marcadas uma a uma e os endereços IP autorizados.
Duas chaves de API na área de cliente com as suas permissões, a última utilização e os endereços IP autorizados
Cada chave mostra as suas permissões, a última utilização e os endereços a partir dos quais é aceite.
Registo das últimas chamadas à API com a rota, o código de resposta, a chave e o endereço IP
As últimas chamadas, recusas incluídas: uma chamada vinda de um endereço não autorizado é rejeitada e aparece aqui.

Encomende servidores com o saldo da sua conta

Os preços, o IVA e a fatura são os da área de cliente, e o servidor é entregue em 60 segundos.

  1. 01Carregue o seu saldo na área de cliente e crie uma chave com a permissão Pedidos, que nunca vem marcada por defeito.
  2. 02Consulte o catálogo: as ofertas à venda e os respetivos preços para a sua conta, IVA incluído.
  3. 03Peça um orçamento com dry_run: o preço exato, sem encomendar nada.
  4. 04Faça a encomenda com uma chave de idempotência: enviada duas vezes, só é registada uma vez.

terminal

$ curl -X POST https://panel.helloserv.fr/api/v1/orders \
    -H "Authorization: Bearer $HELLOSERV_KEY" \
    -H "Idempotency-Key: commande-7f3a9c21" \
    -H "Content-Type: application/json" \
    -d '{"type": "vpsintel", "offer_id": 3,
         "period": "monthly", "os": "debian12"}'

{"data": {
  "order": {"id": 42, "status": "paid"},
  "invoice": {"number": "INV-2026-001234", "status": "paid",
              "total": 9.60},
  "services": [{"id": 5678, "name": "vps-2", "status": "pending"}],
  "balance": 40.40
}}

Uma documentação com um exemplo para cada rota

Cada rota tem o seu pedido curl e a sua resposta. O centro de ajuda explica passo a passo como criar uma chave, limitá-la aos seus endereços IP e fazer uma primeira encomenda.

Documentação da API HelloServ aberta na secção das encomendas

Perguntas sobre a API

Central de ajuda Fale conosco

A API é paga?
Não. Faz parte da área de cliente e funciona com todos os seus serviços.
Que serviços se podem gerir?
Os servidores de jogos, os VPS e os servidores dedicados. O estado e a energia funcionam para os três; a reinstalação diz respeito aos VPS e aos servidores dedicados.
É possível encomendar um servidor dedicado pela API?
Ainda não: a API encomenda servidores de jogos e VPS. Um servidor dedicado encomenda-se no site ou na área de cliente.
Como proteger uma chave?
Dê-lhe apenas as permissões necessárias e limite-a aos endereços IP dos seus servidores, 20 no máximo. Se for divulgada, revogue-a na área de cliente: é recusada de imediato.
Existem limites?
120 pedidos por minuto e por chave, e 10 encomendas por dia com a mesma chave. Acima disso, a API responde com o código 429 e o tempo de espera.

Seu servidor funciona 60 segundos após o pagamento.

Escolha a sua oferta e pague online: o servidor se instala sozinho.