REST API - Dominios de WEDOS.protection - WEDOS Documentation & Knowledge Base

WEDOS REST API está todavía en desarrollo. El acceso y las funciones pueden cambiar sin previo aviso.

Este artículo describe parcialmente el endpoint WEDOS.protection de WEDOS REST API. Servicios de WEDOS.protection y Miembros tienen sus propios artículos. Para WEDOS API (WAPI), consulte WAPI – WEDOS Protection.

Encontrará información básica sobre WEDOS REST API en el artículo WEDOS REST API Manual.

En este artículo encontrará la siguiente información:

Acceso al endpoint DNS
Detalles del endpoint DNS:

Acceso al endpoint WGP

WGP HTTP REST API v2 sirve para gestionar dominios, servicios e invitaciones de cogestión en WEDOS.protection (WGP).

URL base y autenticación

La URL base de los endpoints WGP es: https://api.wedos.com/v2

Para la autenticación se utiliza únicamente OAuth2: incluya un token de acceso válido en la cabecera de la solicitud (Authorization: Bearer <TOKEN>) con el scope wgp . Sin un token válido, la API devuelve el error 2000.

Puede añadir el parámetro example=1 a cualquier endpoint como parámetro GET (?example=1 en los endpoints sin parámetros GET propios; en caso contrario, &example=1). La API devuelve entonces un comando curl de ejemplo para esa llamada, sin necesidad de indicar parámetros reales. También en este modo se requiere una autenticación válida.

Resumen de endpoints

Método	Endpoint	Descripción
GET	`/domains/{domain}`	Detalle de un dominio en WGP
GET	`/domains/templates`	Lista de dominios de plantilla de una variante de servicio concreta
POST	`/domains/create`	Alta de un nuevo dominio en WGP
POST	`/domains/info`	Detalle de uno o varios dominios en WGP
POST	`/domains/{domain}/create/retry`	Reintento del alta del dominio tras un error
POST	`/domains/{domain}/delete-order`	Eliminación de un pedido de dominio sin finalizar

Formato de la respuesta

La respuesta de la API es siempre un objeto JSON con las claves code (código de retorno), msg (descripción textual), request_id (identificador de la solicitud) y, cuando proceda, data (datos devueltos en caso de éxito).

Códigos de retorno generales válidos para todos los endpoints (capa REST, con independencia de la operación concreta):

1000 – operación correcta (OK)
2000 – autenticación (token Bearer de OAuth2) ausente o no válida
2004 – se ha superado el tamaño máximo de la solicitud (URL o cuerpo de la solicitud)
4000 – método de la API desconocido o no admitido (la combinación de método HTTP y ruta invocada no existe)
4001 – la validación de la entrada ha fallado
4005 – no hay ningún ejemplo disponible para el endpoint actual en el modo example=1 .
6000 – error interno al inicializar el comando WAPI subyacente

Además, cada endpoint devuelve sus propios códigos de negocio específicos de la operación (correspondientes al comando WAPI subyacente). Se indican en el apartado Códigos de retorno de cada endpoint.

GET /domains/{domain}

Devuelve información sobre un dominio conectado a WGP: una combinación de los datos de la administración externa de WEDOS Global Protection y de la base de datos interna de WEDOS.

Parámetros:

domain – obligatorio, path – nombre de dominio

Códigos de retorno:

1000 – OK
2100 – falta un parámetro obligatorio
2101 – formato de parámetro no válido
2202 – formato del nombre de dominio no válido o no admitido
2292 – el dominio no existe en WGP para esta cuenta de cliente
2400 – error interno – código de retorno no registrado de la API de WGP (véanse las notas)
2418 – falta el registro TXT de un dominio en el estado Pending_TXT .

Datos de la respuesta:

wgp – datos del dominio procedentes de la administración externa de WGP (p. ej. el estado del dominio, el indicador de cuenta de administrador y más; los elementos wedos_client_id y cms se eliminan de la respuesta)
service – datos del dominio procedentes de la base de datos interna: ID, name, num, user_id, lang, currency, datos de contacto de facturación (cli_*) y del titular (own_*), status, expiration

Ejemplo:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "wgp": {
      "domain": "domain1.tld",
      "state": "active",
      "user_admin": false
    },
    "service": {
      "ID": 435,
      "name": "domain1.tld",
      "num": "2026123456",
      "user_id": 10234,
      "lang": "cs",
      "currency": "CZK",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  }
}

GET /domains/templates

Devuelve una lista paginada de los dominios de plantilla disponibles para la variante de servicio WGP indicada. Utilícela como origen de template_domain_id al dar de alta un dominio o al replicar la configuración.

Parámetros:

variant_id – obligatorio, query – ID de la variante de servicio WGP (véase la lista de códigos hosting_wedos_protection.variants )
per_page – opcional, query – registros por página; predeterminado 15, el valor -1 devuelve todos los registros
page – opcional, query – número de página; predeterminado 1
locale – opcional, query – idioma de la paginación, valores permitidos cs, en; predeterminado en
search – opcional, query – cadena de búsqueda en las columnas custom_name, name

Códigos de retorno:

1000 – OK
2100 – falta un parámetro obligatorio (variant_id)
2400 – error interno – código de retorno no registrado

Datos de la respuesta:

data – array de dominios de plantilla; cada elemento contiene id, custom_name, name, url
per_page, total, last_page, from, to – detalles de la paginación
first_page_url, prev_page_url, next_page_url, last_page_url, path – enlaces a las distintas páginas
links – array de elementos de paginación (url, label, active)

Ejemplo:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/templates?variant_id=1'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "data": [
      {
        "id": 123,
        "custom_name": "Sample e-shop",
        "name": "template-eshop.wedos.com",
        "url": "https://template-eshop.wedos.com"
      }
    ],
    "per_page": 15,
    "total": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "path": "https://api.wedos.com/v2/wgp/domains/templates",
    "first_page_url": "https://api.wedos.com/v2/wgp/domains/templates?page=1",
    "prev_page_url": null,
    "next_page_url": null,
    "last_page_url": "https://api.wedos.com/v2/wgp/domains/templates?page=1",
    "links": [
      {"url": null, "label": "&laquo; Previous", "active": false},
      {"url": "https://api.wedos.com/v2/wgp/domains/templates?page=1", "label": "1", "active": true},
      {"url": null, "label": "Next &raquo;", "active": false}
    ]
  }
}

POST /domains/info

Devuelve información sobre uno o varios dominios en WGP (equivalente a GET /domains/{domain}, pero en el cuerpo de la solicitud puede indicar varios dominios separados por comas).

Parámetros:

domain – obligatorio – nombre del dominio, o varios nombres separados por comas (p. ej. "domain1.tld,domain2.tld")

Códigos de retorno:

1000 – OK
2100 – falta un parámetro obligatorio
2101 – formato de parámetro no válido
2202 – formato del nombre de dominio no válido o no admitido
2292 – el dominio no existe en WGP para esta cuenta de cliente
2400 – error interno – código de retorno no registrado de la API de WGP
2418 – falta el registro TXT de un dominio en el estado Pending_TXT .

Datos de la respuesta: Para un dominio, la misma estructura que GET /domains/{domain} (claves wgp y service). Para varios dominios, la respuesta es un objeto indexado por el nombre del dominio, donde cada elemento vuelve a tener la estructura wgp y service .

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/domains/info' \
  --data '{"domain":"domain1.tld,domain2.tld"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain1.tld": {
      "wgp": {"domain": "domain1.tld", "state": "active", "user_admin": false},
      "service": {"ID": 435, "name": "domain1.tld", "status": "active", "expiration": "2027-10-01 00:00:00"}
    },
    "domain2.tld": {
      "wgp": {"domain": "domain2.tld", "state": "active", "user_admin": false},
      "service": {"ID": 436, "name": "domain1.tld", "status": "active", "expiration": "2027-03-15 00:00:00"}
    }
  }
}

POST /domains/create

Da de alta un nuevo dominio en WGP. También sirve para restaurar un dominio que fue suspendido (estado disabled) porque su alta no se completó a tiempo tras la creación.

Parámetros:

domain – obligatorio – nombre de dominio
variant_id – obligatorio, número – ID de la variante de servicio (véase la lista de códigos hosting_wedos_protection.variants )
period_id – obligatorio, número – ID del periodo de suscripción
upstream_ips – opcional, array – array de direcciones IP que no se resolverán hacia WGP
template_domain_id – opcional, número – ID del dominio de plantilla utilizado para configurar el nuevo dominio
mode – opcional, cadena – modo del dominio, valores permitidos ns o cname

Códigos de retorno:

1000 – OK (restauración de un dominio previamente suspendido desde el estado disabled )
1001 – solicitud aceptada, el alta del dominio se está procesando
2101 – valor de parámetro no válido
2202 – formato del nombre de dominio no válido o no admitido
2203 – valor no válido de period_id
2272 – formato de dirección IP no válido (upstream_ips)
2273 – valor no válido de variant_id
2276 – TLD no soportado
2277 – no se permite un www. explícito en el nombre del dominio
2278 – ya existe un servicio para este dominio
2279 – la cuenta de prepago está bloqueada
2281 – la cuenta de prepago no está activa
2282 – no se puede pagar desde la cuenta de prepago en la moneda indicada
2283 – saldo insuficiente en la cuenta de prepago
2284 – error en los datos de contacto de la cuenta de prepago
2285 – configuración de facturación incorrecta con/sin IVA
2291 – el dominio ya existe en WGP para esta cuenta de cliente
2293 – no se puede obtener el saldo de crédito de la cuenta de prepago
2294 – no se puede obtener el precio del servicio
2416 – modo de dominio no válido (mode)
2417 – formato del nombre de subdominio no válido o no admitido
2422 – no se puede determinar el tipo de cuenta (administrador/cliente)
2423 – error interno al llamar a la API de WGP
otros códigos de error específicos de la operación (p. ej. la validación de la replicación del dominio de plantilla 2401–2405)

Datos de la respuesta:

WGP_ID – ID del dominio en WGP
domain – nombre de dominio
order_num – número de pedido (salvo que el dominio se dé de alta de forma gratuita o desde una cuenta de administrador; también en la restauración desde el estado disabled )
currency, amount – moneda e importe descontados de la cuenta de prepago
acc_amount_before, acc_amount_current – saldo de la cuenta de prepago antes y después del pago
desc – descripción (presente solo al restaurar un dominio desde el estado disabled )

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/domains/create' \
  --data '{"domain":"domain1.tld","variant_id":1,"period_id":1,"mode":"ns"}'

{
  "code": 1001,
  "msg": "Request pending",
  "request_id": "a1b2c3d4",
  "data": {
    "WGP_ID": 98765,
    "domain": "domain1.tld",
    "order_num": "2026123456",
    "currency": "CZK",
    "amount": -499,
    "acc_amount_before": 1500,
    "acc_amount_current": 1001
  }
}

POST /domains/{domain}/create/retry

Reintenta un alta de dominio que terminó con error (disponible solo para determinados estados del dominio, p. ej. error_crt).

Parámetros:

domain – obligatorio, path – nombre de dominio

Códigos de retorno:

1000 – OK
2100 – falta un parámetro obligatorio
2292 – el dominio no existe en WGP para esta cuenta de cliente
2400 – error interno – código de retorno no registrado

Datos de la respuesta:

domain – nombre de dominio
domain_id – ID del dominio en WGP
wedos_client_id – ID del cliente en WGP

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld/create/retry'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234
  }
}

POST /domains/{domain}/delete-order

Elimina un pedido de dominio sin finalizar: la situación en la que el dominio se queda bloqueado en WGP sin posibilidad de completar la activación y el servicio local aún no existe.

Parámetros:

domain – obligatorio, path – nombre de dominio

Códigos de retorno:

1000 – OK
2100 – falta un parámetro obligatorio
2292 – el dominio no se encontró en WGP para esta cuenta de cliente
2400 – error interno
2410 – servicio no encontrado
2421 – el servicio WGP ya existe, el dominio no se eliminará

Datos de la respuesta:

domain – nombre de dominio
domain_id – ID del dominio en WGP
wedos_client_id – ID del cliente en WGP

Ejemplo:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/domains/domain1.tld/delete-order'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234
  }
}

¿Le ha resultado útil?

¡Gracias por su valoración!

REST API – Dominios de WEDOS.protection

Acceso al endpoint WGP

URL base y autenticación

Resumen de endpoints

Formato de la respuesta

GET /domains/{domain}

GET /domains/templates

POST /domains/info

POST /domains/create

POST /domains/{domain}/create/retry

POST /domains/{domain}/delete-order

¿Le ha resultado útil?

Índice del artículo

Explorar categorías