API InovHost — Controle de VPS

1 URL base

Toda chamada é um POST para essa URL, com o parâmetro action na query string:

https://cliente.inovhost.com/modules/addons/vmware/center.php

POST https://cliente.inovhost.com/modules/addons/vmware/center.php?action=vm_power_on

2 Autenticação

Envie o token no header Authorization:

Authorization: Bearer rvps_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Se por algum motivo o seu sistema não conseguir enviar headers customizados, existe um fallback: envie o token como campo do corpo do POST:

api_token=rvps_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

3 Formato de resposta

Por padrão a API responde em um formato antigo (tags soltas, mantido por compatibilidade com o WHMCS). Para integração externa, peça JSON — envie um dos dois:

• Header Accept: application/json
• Parâmetro ?format=json na URL (ou format=json no corpo do POST)

Exemplo de resposta JSON:

{
  "result": "success",
  "msg": "Sucesso! O comando foi executado!",
  "success": true
}

success é sempre true quando result é exatamente "success", e false em qualquer outro caso (incluindo os códigos de erro da seção 6). Trate success como a fonte da verdade — o texto de result/msg pode variar.

4 Ações disponíveis

Todas exigem ip (o IP dedicado da VPS) exceto conn e vm_create (que ainda não têm uma VPS associada). O IP pode ser enviado com ou sem porta (191.101.x.x ou 191.101.x.x:5900) — a porta é ignorada.

Campos usados em mais de uma ação

• product — nome exato do produto tal como cadastrado no WHMCS (ex: "VPS CA 2 GB"). Peça essa lista ao InovHost.
• service_api — um identificador que o seu sistema escolhe e controla (não é gerado por nós). Serve para rastrear qual VPS/pedido corresponde a qual registro interno seu.
• whmcs_url — obrigatório por herança do formato antigo; pode enviar a URL do seu próprio sistema.
• billingcycle — ciclo de cobrança do pedido (ex: monthly, quarterly, annually) — precisa ser um ciclo válido do produto no WHMCS.
• guest_os_version — precisa bater exatamente com um valor de uma lista de sistemas operacionais que o InovHost mantém. Peça essa lista ao InovHost antes de integrar — não há endpoint público para consultá-la ainda.

4.1 Exemplos

Ligar uma VPS

# liga a VPS informada
curl -X POST "https://cliente.inovhost.com/modules/addons/vmware/center.php?action=vm_power_on&format=json" \
  -H "Authorization: Bearer rvps_SEU_TOKEN_AQUI" \
  -d "ip=191.101.20.15"

Resposta:

{ "result": "success", "msg": "Sucesso! O comando foi executado!", "success": true }

Criar uma VPS nova

curl -X POST "https://cliente.inovhost.com/modules/addons/vmware/center.php?action=vm_create&format=json" \
  -H "Authorization: Bearer rvps_SEU_TOKEN_AQUI" \
  -d "product=VPS CA 2 GB" \
  -d "service_api=meu-id-interno-123" \
  -d "whmcs_url=https://sistema-do-programador.com" \
  -d "billingcycle=monthly" \
  -d "guest_os_version=Ubuntu 20.04"

Consultar se a VPS já ficou pronta (vm_status)

A criação (vm_create) é assíncrona: o pedido é aceito na hora, mas o provisionamento real acontece depois, numa fila interna. Use o mesmo service_api enviado no vm_create para consultar o andamento — faça polling (por exemplo, a cada 15–30s) até ready vir true:

curl -X POST "https://cliente.inovhost.com/modules/addons/vmware/center.php?action=vm_status&format=json" \
  -H "Authorization: Bearer rvps_SEU_TOKEN_AQUI" \
  -d "service_api=meu-id-interno-123"

{
  "result": "success",
  "domain_status": "Pending",
  "ip": "",
  "ready": "0",
  "msg": "Status consultado com sucesso!",
  "success": true
}

{
  "result": "success",
  "domain_status": "Active",
  "ip": "191.101.20.15",
  "ready": "1",
  "msg": "Status consultado com sucesso!",
  "success": true
}

domain_status segue os valores padrão do WHMCS (Pending, Active, Suspended, Terminated, Cancelled). Use o campo ready como sinal definitivo de "pronta para uso" — só vem "1" quando o status é Active e já existe um IP atribuído.

5 Avisos importantes

Leia antes de integrar.

6 Erros

Resposta de erro (formato JSON):

{ "result": "error12", "msg": "Erro! Não foi possível autenticá-lo", "success": false }