API DE CLIENTES · V1 BETA
API REST para
VPS y servidores dedicados
Gestione sus servidores desde código: pida y destruya VPS por horas, ejecute acciones de energía y reinstalaciones, capture y despliegue sus propias imágenes y pague facturas con crédito.
La API de clientes de X-ZoneServers (v1, beta pública) ofrece 92 operaciones sobre HTTPS, con una especificación OpenAPI 3.0, claves de API con ámbitos y un límite predeterminado de 1.000 solicitudes por hora y clave. Está incluida en todas las cuentas sin coste adicional.
92 operaciones de API1.000 solicitudes por hora y clave
Su primera llamada
Cree una clave en el área de cliente, en Profile → API Keys, y luego pregunte a la API quién es usted.
curl https://my.x-zoneservers.com/api/v1/ \
-H "Authorization: Bearer $XZ_API_KEY"
{ "success": true,
"data": {
"version": "1",
"key": { "scopes": ["read", "services"] },
"rate_limit": { "limit": 1000, "remaining": 999 }
} }01Características
Qué puede automatizar
La API cubre todo el ciclo de vida de un servidor, del pedido a la factura, con los mismos permisos que el área de cliente.
Despliegue y destrucción
Pida un VPS con facturación por horas o mensual, pase user-data de cloud-init y claves SSH para el primer arranque, y elimínelo cuando termine el trabajo. La facturación por horas se detiene en el momento en que el servidor desaparece.
Energía, reinstalación y estadísticas
Inicie, detenga, reinicie y reinstale sus VPS, restablezca contraseñas de root y consulte estadísticas de uso y tráfico desde sus scripts de monitorización.
Imágenes personalizadas
Capture un VPS como imagen (hasta 3 por cuenta) o registre su propia imagen qcow2 o raw (verificada mediante SHA-256) y despliegue nuevos servidores a partir de ella.
Facturación y consumo
Consulte su saldo de crédito y los cargos por horas de este mes, liste facturas y proformas, y páguelas con crédito — útil para paneles de costes y alertas de presupuesto.
Complementos y mejoras
Compre complementos para un servicio existente, como direcciones IP adicionales, o páselo a un plan superior sin abrir el área de cliente.
Proyectos y claves con ámbitos
Agrupe servidores en proyectos y genere claves vinculadas a un único proyecto, de modo que una clave de staging nunca pueda ver ni tocar producción.
02Cómo funciona
Ejemplo: un VPS por horas para un único trabajo de CI
Cree una máquina de build limpia, ejecute el pipeline, elimínela — y pague las horas que existió.
Los servicios por horas se cobran del crédito de su cuenta en lugar de facturarse, así que mantenga saldo en la cuenta. Envíe una cabecera Idempotency-Key con cada pedido: así, una solicitud que haya agotado el tiempo de espera podrá reintentarse sin crear un segundo servidor.
1. Elija un plan: liste los productos con sus precios por hora y mensuales.
curl https://my.x-zoneservers.com/api/v1/products \
-H "Authorization: Bearer $XZ_API_KEY"2. Pídalo con facturación por horas, con un script de primer arranque y su clave SSH.
curl -X POST https://my.x-zoneservers.com/api/v1/orders \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Idempotency-Key: ci-run-4812" \
-H "Content-Type: application/json" \
-d '{"productId": "<plan-id>", "billingCycle": "hourly",
"hostname": "ci-4812.example.com", "location": "<location>",
"configOptions": {"os_image_id": "<image-id>",
"ssh_keys": ["ssh-ed25519 AAAA... ci@runner"],
"user_data": "#!/bin/sh\n/opt/ci/run-pipeline.sh"}}'3. Cuando termine el trabajo, elimine el servidor. La facturación se detiene de inmediato.
curl -X DELETE https://my.x-zoneservers.com/api/v1/vps/<vps-id> \
-H "Authorization: Bearer $XZ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"immediate": true}'03API
Diseñada para scripts y agentes de IA
Cuando quien pulsa los botones es un programa y no una persona, un comportamiento predecible importa más que el número de endpoints.
Claves con ámbitos
Cada clave lleva solo los ámbitos que usted conceda —read, services, orders, billing, destructive—, además de una lista de IP permitidas y una fecha de caducidad opcionales.
Límites de tasa publicados
1.000 solicitudes por hora y clave por defecto, indicadas en las cabeceras X-RateLimit, con breves periodos de espera por servidor en las acciones de energía y reinstalación.
Reintentos seguros
Los pedidos aceptan una Idempotency-Key y cada rechazo devuelve un código de error legible por máquina, de modo que la automatización puede distinguir un fallo reintentable de uno real.
Documentación legible por máquina
Una especificación OpenAPI 3.0 para generadores de clientes y una guía en Markdown plano que los asistentes de programación y los agentes de IA pueden leer directamente.
04Relacionado
¿Vende servidores a sus propios clientes?
Esta API de clientes automatiza su propia cuenta. Para revender con su propia marca, únase al programa de revendedores y use en su lugar la API de revendedores: precios mayoristas con niveles por volumen, solicitudes firmadas con HMAC, webhooks, claves vinculadas a clientes y enlaces de consola que sus clientes abren sin necesidad de tener una cuenta con nosotros.
05Preguntas
Preguntas frecuentes sobre la API
Preguntas habituales sobre cómo automatizar X-ZoneServers.
¿Tiene X-ZoneServers una API?
Sí. La API de clientes (v1) es una API REST sobre HTTPS en https://my.x-zoneservers.com/api/v1 con 92 operaciones que cubren VPS, servidores dedicados, pedidos, complementos, mejoras, facturas, claves SSH e imágenes personalizadas. Está en beta pública: es lo bastante estable para desarrollar sobre ella, pero los endpoints y el formato de las respuestas aún pueden cambiar.
¿El acceso a la API es gratuito?
Sí. El acceso a la API está incluido en todas las cuentas sin coste adicional; solo paga los servidores y complementos que pida, a los mismos precios que en el sitio web y en el área de cliente.
¿Puedo crear y eliminar VPS por horas a través de la API?
Sí. Haga un pedido con el ciclo de facturación configurado por horas, opcionalmente con user-data de cloud-init y claves SSH, y elimine el VPS cuando ya no lo necesite. Los servicios por horas se cobran del crédito de la cuenta y dejan de facturarse en cuanto se eliminan.
¿La API funciona con servidores dedicados?
En parte. Para los servidores dedicados, la API cubre los pedidos, los complementos, las facturas y los detalles del servicio. El control de energía, la reinstalación del sistema operativo y el restablecimiento de contraseñas no están disponibles para servidores dedicados, ni a través de la API ni desde el área de cliente.
¿Cómo me autentico?
Cree una clave de API en el área de cliente, en Profile → API Keys, y envíela como token Bearer. Elija sus ámbitos al crearla y, si lo desea, restrínjala a direcciones IP concretas o asígnele una fecha de caducidad. Las claves se muestran una sola vez y pueden revocarse en cualquier momento desde el área de cliente.
¿Existe una especificación OpenAPI o Swagger?
Sí. La especificación OpenAPI 3.0 completa está publicada en https://my.x-zoneservers.com/api/v1/openapi.json, junto a la documentación renderizada y una guía de uso en Markdown.
Empezar
Cree su primera clave de API
Inicie sesión en el área de cliente, abra Profile → API Keys y haga su primera llamada en menos de un minuto. Las preguntas sobre la API llegan directamente a las personas que desarrollan la plataforma.