Documentação da API, Terraform e CLI
Referência da API, guias para Terraform, linha de comando, Go SDK e aplicativo móvel, e uma introdução para usuários iniciantes da API.
Comece pela API
A API da VPSie está aberta a todos os clientes. A referência é publicada e você pode testar chamadas ao vivo.
Primeiros passos com a API
Cinco passos do zero até uma chamada funcional.
- Crie um cliente de API ou token de acesso no console em Acesso à API
- Troque o ID do cliente e o segredo do cliente por um token de curta duração, ou use um token de acesso pessoal
- Envie o token no cabeçalho
vpsie-auth - Chame
GET /datacenterpara provar que nome, rota e token funcionam - Leia a referência para cada endpoint, campo e exemplo
Endereço base https://api.vpsie.com/apps/v2. JSON na entrada e na saída. Em uma instalação privada, use seu próprio host de API; o caminho após o host é o mesmo.
Guias para cada público e ferramenta
Um guia por público e ferramenta. Cada um descreve o que cobre e para quem é.
Guia da API do usuário
Autentique, crie e gerencie servidores, proteja-os, leia faturas e trate erros, incluindo como conectar ferramentas de ERP e CRM e instalações privadas.
- Versões curta e completa
- Exemplos em curl
Guia da API do revendedor
Cadastre clientes, atribua planos e preços, adicione crédito, leia o uso e extraia dados de faturamento do seu próprio portal.
- Versões curta e completa
- Limitado aos seus clientes
Guia do aplicativo móvel
Cada menu do aplicativo VPSie Cloud para iOS e Android, e o que esperar quando um recurso não está habilitado na sua conta.
- Faça login por e-mail, QR com Client ID ou biometria
Guia do Terraform
O provedor VPSie para Terraform e OpenTofu gerencia servidores, redes, armazenamento e Kubernetes como código.
- Provedor vpsie/vpsie
- Importar recursos existentes
Guia de linha de comando
O vpsiecli gerencia servidores, snapshots, firewalls e faturamento a partir do seu shell, para scripts e CI.
- 28 grupos de comandos, 204 comandos
- Token de uma configuração YAML
Guia do SDK Go
O govpsie é o cliente Go para a API: servidores, armazenamento, rede, DNS, Kubernetes, faturamento e mais como métodos tipados.
- Licença MPL-2.0
- Go 1.24
Ferramentas de código aberto
Provider do Terraform
Publicado no Terraform Registry como vpsie/vpsie. Compatível com OpenTofu.
Go SDK
github.com/vpsie/govpsie, documentado em pkg.go.dev.
API de administração
A API de operador para uma plataforma VPSie que você opera (clientes, planos, infraestrutura, faturamento, licenciamento, auditoria). Inclui a instalação de nuvem privada.
- Solicite o guia ao seu contato VPSie
Qual ferramenta para qual tarefa
| Ferramenta | Ideal para | Não indicado para |
|---|---|---|
| API REST | Qualquer linguagem, integrações com ERP e CRM, tarefas pontuais | Manter todo o ambiente sincronizado com o código |
| Terraform | Ambientes repetíveis que você revisa antes de aplicar | Alterações pontuais de uma única vez |
| Linha de comando | Scripts de shell, jobs de CI, ações rápidas | Serviços de longa duração (use o SDK) |
| Go SDK | Serviços que você constrói e distribui em Go | Outras linguagens (use a API REST) |
| Aplicativo móvel | Verificar servidores e faturamento em movimento | Trabalho em massa |
Mais ajuda
Base de conhecimento
Guias práticos, tutoriais de aplicativos com um clique e respostas para perguntas comuns.
Perguntas frequentes
Respostas curtas sobre planos, localizações, faturamento e segurança.
Dúvidas sobre a documentação da VPSie
A API está disponível em todos os planos?
Papéis, status da conta e sua licença se aplicam às chamadas de API exatamente como no console. Uma chamada a um serviço não incluído na sua licença é recusada, mesmo que o endpoint esteja documentado.
Posso executar um script contra uma instalação privada da VPSie?
Sim. Use seu próprio nome de host da API em vez de api.vpsie.com. O caminho após o host é o mesmo, e o chamador deve confiar no certificado apresentado pela instalação.
Os campos mudarão?
Sim. A plataforma e sua API mudam com o tempo. Escreva código que ignore novos campos e verifique apidocs.vpsie.com antes de um lançamento.
Onde faço o download dos guias?
Os guias são documentos em PDF e Word compartilhados pela VPSie. Solicite ao seu gerente de conta ou ao suporte o conjunto atual.
Base de conhecimento por tópico
Onde procurar na base de conhecimento para cada tipo de pergunta.
| Se você está trabalhando em | Procure por | Página relacionada |
|---|---|---|
| Servidores e sistemas operacionais | Criação, redimensionamento, reconstrução e acesso a servidores em nuvem; acesso via SSH e console | Computação |
| Armazenamento e arquivos | Adição de discos, montagem de volumes, uso de buckets de armazenamento de objetos | Armazenamento, Buckets |
| Rede e DNS | Redes privadas, firewalls, balanceamento de carga, endereços IP, registros DNS | Rede, DNS |
| Containers | Clusters e workloads do Kubernetes | Kubernetes |
| Backup e recuperação | Snapshots, backups agendados, restauração de um servidor | Backup, Recuperação |
| Aplicativos com um clique | Instalação e configuração de aplicativos prontos | Aplicativos |
| Segurança e acesso | Login com fator duplo, chaves, papéis de usuário, endurecimento de um servidor | Segurança |
| Migração | Importação de máquinas de outra plataforma | Migração |
Ordem de leitura para novos usuários
Um caminho pela documentação que evita becos sem saída.
Criar uma conta
Cadastre-se em my.vpsie.com, adicione um método de pagamento e implante um primeiro servidor.
Conheça o console
Use a base de conhecimento para as primeiras tarefas de servidor, armazenamento e rede.
Automatize uma tarefa
Faça sua primeira chamada de API a partir do início rápido acima e, em seguida, escolha a CLI ou o Terraform para trabalho repetível.
Proteja-o
Configure backups e um teste de restauração antes da chegada dos primeiros dados reais.
Construa na VPSie
Crie uma conta, emita um token e faça sua primeira chamada.