WAPI - Protección WEDOS (WGP)

Este artículo proporciona información sobre los siguientes comandos:

• wgp-domain-create - añadir un dominio a WEDOS Protection
• wgp-domain-info - lista la información del dominio de protección WEDOS
• wgp-domain-renew - renovar servicio
• wgp-domain-delete - dar de baja el servicio
• wgp-domain-update-subscription – change subscription plan
• wgp-domain-retry - resolver algunos errores
• wgp-domain-cache-purge - purgar la caché de WP
• wgp-domain-template-replicate - replica una plantilla en un dominio existente
• wgp-domain-templates-list - lista de plantillas de dominio
• wgp-services-list - Lista de dominios de protección WEDOS

---

wgp-domain-create

Utilice la petición wgp-domain-create para crear un registro de dominio en WEDOS Protection. Esta petición es asíncrona y se comunica mediante notificaciones ⧉.

Parámetros

• domain = nombre de dominio (obligatorio)
• variant_id = plan de servicio (obligatorio) - 1 = Inicio, 2 = Avanzado, 3 = Experto(puede encontrar los planes y sus precios en el sitio del producto ⧉)
• period_id = periodo de servicio (obligatorio) - 1 = mensual, 4 = anual
• upstream_ips = matriz de direcciones IP de destino (opcional) - puedes encontrar más información sobre IPs de destino en el artículo Protección - DNS e IPs de destino.
• template_domain_id = ID del dominio de la plantilla (opcional)
• modo = modo de dominio (opcional)
  • ns = utiliza WEDOS NS (por defecto); el sistema activará el dominio sólo si comprueba correctamente que utiliza WEDOS DNS.
  • cname = permite utilizar los servidores DNS de otro proveedor, o añadir subdominios mediante el registro CNAME; el modo para cualquier dominio de tercer nivel o superior es siempre cname.

Valores de retorno

• 1000 = OK
• 1001 = Solicitud pendiente
• 2101 = Parámetros no coincidentes
• 2202 = Formato de nombre de dominio no válido o no admitido
• 2203 = Period_id no válido
• 2206 = Solicitud no válida - error interno
• 2272 = Formato no válido de la dirección ip
• 2273 = Variante no válida
• 2274 = Error interno - falta el parámetro user_id
• 2275 = Error interno - usuario no encontrado
• 2276 = TLD no soportado o nivel de dominio máximo excedido
• 2277 = No se permite anteponer explícitamente www. al nombre de dominio
• 2278 = No se puede utilizar el nombre de dominio - hay servicio con este nombre de dominio
• 2279 = Cuenta de crédito bloqueada
• 2280 = Cuenta de crédito activa
• 2281 = Cuenta de crédito inactiva
• 2282 = Moneda de la cuenta de crédito no válida
• 2283 = Importe no válido o crédito insuficiente
• 2284 = Error en la información de la cuenta de crédito
• 2285 = Configuración incorrecta del IVA
• 2286 = Cuenta de crédito - error interno
• 2290 = Cuenta de crédito - la actividad no se ha añadido a la cuenta de crédito
• 2291 = El dominio ya existe para esta cuenta de cliente en la API WGP
• 2293 = No se puede obtener el saldo de la cuenta de crédito
• 2294 = No se puede retirar el precio del servicio
• 2295 = No se ha podido crear el dominio a WGP. El pago ha sido cancelado.
• 2296 = Movimiento de cuenta de crédito no anulable
• 2400 = Error Intenral WGP
• 2401 = No se puede aplicar la plantilla al dominio
• 2402 = Plantilla de dominio no válida
• 2403 = No coinciden la plantilla de dominio y el usuario
• 2404 = Plantilla de dominio y plan de dominio no coinciden
• 2405 = Dominio de plantilla diario alcanzado
• 2416 = Modo de dominio no válido

Datos de respuesta

• WGP_ID = ID de registro de dominio WGP
• dominio = nombre de dominio
• order_num = número de pedido
• moneda = moneda de la cuenta de crédito
• importe = precio del servicio
• acc_amount_before = saldo de la cuenta de crédito antes de la activación del servicio
• acc_amount_current = saldo de la cuenta de crédito tras la activación del servicio

Datos de respuesta a la notificación

• WGP_ID = ID de registro de dominio WGP
• dominio = nombre de dominio
• order_num = número de pedido

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-create",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld",
      "variant_id": "1 = Start, 2 = Advanced, 3 = Expert",
      "period_id": "1 = monthly billing, 4 = yearly billing",
      "upstream_ips": ["IP address 1", "IP address 2", "(optional)"],
      "template_domain_id": "ID of the template domain (optional)",
      "mode": "domain mode (optional)"
    }
  }
}

Respuesta JSON (solicitud pendiente):

{
  "response": {
    "code": 1001,
    "result": "Request pending",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-create",
    "data": {
      "WGP_ID": "assigned domain ID in WG",
      "domain": "domain_name.tld",
      "order_num": "order number",
      "currency": "currency code",
      "amount": "price",
      "acc_amount_before": "credit account balance before transaction",
      "acc_amount_current": "credit account balance after transaction"
    }
  } 
}

Notificación JSON una vez finalizada la configuración:

{
  "notify": {
    "code": "1000",
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-create",
    "id": "POLL queue ID",
    "data": {
      "WGP_ID": "assigned domain ID in WG",
      "domain": "domain_name.tld",
      "order_num": "order number",
    }
  }
}

---

wgp-domain-info

Utilice la petición wgp-domain-info para mostrar información sobre el estado del dominio en el servicio WEDOS Protection.

Parámetros

• domain = nombre de dominio (obligatorio)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2101 = Parámetros no coincidentes
• 2202 = Formato de nombre de dominio no válido o no admitido
• 2206 = Solicitud no válida - error interno
• 2292 = Dominio no encontrado para esta cuenta de cliente en la API WGP

Datos de respuesta

• wgp = estado del dominio en WEDOS Protection; el estado tiene uno de los siguientes valores, algunos de los cuales pueden contener datos diferentes:
  • pending_dns = resolución del registro DNS del dominio en curso
  • procesamiento = espera de la configuración del servicio
  • atascado = a la espera de los requisitos del software
  • pending_txt = a la espera de la verificación del registro TXT(plantilla parcial)
  • pending_ns = a la espera de la configuración del servidor de nombres(plantilla parcial para el modo NS y el modo CNAME)
  • pending_dns_refresh = resolución DNS repetida, si pending_dns anterior no encontró ningún registro DNS
  • pending_crt = esperando certificado Let's Encrypt para WG
  • activo = dominio activo(plantilla completa)
• service = estado del dominio en el sistema WEDOS

Encontrará información más detallada sobre los datos de devolución en la plantilla.

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-info",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

Respuesta JSON (OK, estado activo):

{
  "response": {
    "code": 1000,
    "result": "ok",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-info",
    "data": {
    "wgp":{
        "domain": "domain_name.tld",
        "domain_id": "assigned domain ID",
        "domain_tld": "tld",
        "modes": ["režim domény"],
        "settings": {
          "cache": "cache status (empty off, 1 on)"
        },
        "url": "https:\/\/client.wedos.global\/protection\/domains\/domain_name.tld",
        "state": "active",
        "state_data": {
          "dns_ip_addresses": ["WG proxy IPv4 address", "WG proxy IPv6 address"],
          "dns_pointing_to_proxy": "DNS proxy routing check, empty false, 1 true",
          "dns_records_new": [
            {
              "name": "",
              "data": "WG proxy IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "WG proxy IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "",
              "data": "WG proxy IPv6 address",
              "type": "AAAA",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "WG proxy IPv6 address",
              "type": "AAAA",
              "ttl": 300
            }
          ],
          "dns_records": [
            {
              "name": "",
              "data": "current IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "*",
              "data": "current IPv4 address",
              "type": "A",
              "ttl": 300
            },
            {
              "name": "",
              "data": "current IPv6 address",
              "type": "AAAA",
              "ttl": 300
            },
            {
              "name": "",
              "data": "current IPv6 address",
              "type": "AAAA",
              "ttl": 300
            }
          ]
        }
      },
      "service": {
        "ID": "service ID in the system",
        "name": "domain_name.tld",
        "num": "order number",
        "user_id": "user ID in the system",
        "lang": "language code",
        "currency": "currency code",
        "cli_legal_type": "Billing - 1 = natural person, 2 = enterpreneur, 3 = legal person",
        "cli_company" :"Billing – Company name",
        "cli_fname": "Billing – Name",
        "cli_lname": "Billing – Surname",
        "cli_email": "Billing – Email",
        "cli_email2": "Billing – Backup email",
        "cli_phone": "Billing – Phone",
        "cli_mobile": "Billing – Mobile",
        "cli_fax": "Billing – Fax",
        "cli_ic": "Billing – Company ID",
        "cli_dic": "Billing – VAT ID",
        "cli_taxpayer": "Billing – VAT payer (0/1)",
        "cli_addr_street": "Billing – Street and number",
        "cli_addr_city": "Billing – Town",
        "cli_addr_zip": "Billing – ZIP",
        "cli_addr_country": "Billing – Country code",
        "cli_name_vies": "Billing – VIES name",
        "own_legal_type": "Operator - 1 = natural person, 2 = enterpreneur, 3 = legal person",
        "own_company": "Operator – Company name",
        "own_fname": "Operator - Name",
        "own_lname": "Operator - Surname",
        "own_email": "Operator - Email",
        "own_phone": "Operator - Phone",
        "own_ic": "Operator - Company ID",
        "own_dic": "Operator - VAT ID",
        "own_addr_street": "Operator – Street and number",
        "own_addr_city": "Operator - Town",
        "own_addr_zip": "Operator - ZIP",
        "own_addr_country": "Operator – Country code",
        "status": "service status in WEDOS customer administration",
        "expiration": "expiration date YYYY-MM-DD"
      }
    }
  }
}

Datos JSON (OK, estado pendiente_txt):

{
    ...
    "data": {
        ...
        "state": "pending_txt",
        "state_data": {
            "name": "_TXT_record_name",
            "name_formatted": "_TXT_record_name_with_domain.tld",
            "value": "TXT-record-value--verification-code"
        }
    }
}

Datos JSON (OK, estado pending_ns en modo ns ):

{
    ...
    "data": {
        ...
        "state": "pending_ns",
        "state_data": {
            "assigned": [ 
                "assigned-nameserver.ns.wedos.net",
                "assigned-nameserver.ns.wedos.com",
                "assigned-nameserver.ns.wedos.eu",
                "assigned-nameserver.ns.wedos.cz"
            ],
            "assigned_own": [ 
                [
                    "own-ns1.if-permitted.tld",
                    "own-ns2.if-permitted.tld"
                ]
            ],
            "resolved": [ 
                "current-resolved-ns1.domain.tld",
                "current-resolved-ns2.domain.tld"
            ],
            "resolved_at": "UTF timestamp of last performed DNS check",
            "next_resolve_at": "UTF timestamp of next scheduled DNS check"
        }
    }
}

Datos JSON (OK, estado pendientes_ns en cnombre modo; crt_name y cname son nombres de registros y valores para que el usuario los establezca con su proveedor de DNS):

{
    ...
    "state_data": {
            "crt_cname": [
                {
                    "name": "_acme-challenge",
                    "value": "_acme-challenge.verification_code.wgp123.wedos.global"
                }
            ],
            "cname": [
                {
                    "name": "*",
                    "value": "verification_code.wgp123.wedos.global"
                },
                {
                    "name": "www",
                    "value": "verification_code.wgp123.wedos.global"
                }
            ],
            "resolved_at": "UTF timestamp of last performed DNS check",
            "next_resolve_at": "UTF timestamp of next scheduled DNS check"
        }

    }
}

---

wgp-domain-renew

Utilice la petición wgp-domain-renew para ampliar el dominio en el servicio WEDOS Protection durante otro periodo.

Parámetros

• service_id = ID del servicio (obligatorio)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2101 = Parámetros no coincidentes
• 2152 = Renovación del servicio bloqueada
• 2206 = Falta user_id
• 2279 = Cuenta de crédito bloqueada
• 2281 = Cuenta de crédito inactiva
• 2282 = Moneda de la cuenta de crédito no válida
• 2283 = Importe no válido o crédito insuficiente
• 2284 = Error en la información de la cuenta de crédito
• 2286 = Cuenta de crédito - error interno
• 2293 = No se puede obtener el saldo de la cuenta de crédito
• 2406 = Dominio/servicio no encontrado
• 2409 = Error en la renovación del servicio

Datos de respuesta

• service_id = ID del servicio
• name = Nombre de dominio
• date_from = Fecha de validez del servicio
• date_to = Fecha de expiración del servicio
• fakt_order_num = Número de pedido para la renovación del servicio
• divisa = Divisa de la cuenta de crédito
• precio = Precio de renovación
• credit = Saldo acreedor de la cuenta tras la renovación

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-renew",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID"
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-renew",
    "data": {
      "service_id":"service ID",
      "domain":"domain_name.tld",
      "date_from":"YYYY-MM-DD",
      "date_to":"YYYY-MM-DD",
      "fakt_order_num":"Order nr.",
      "currency":"Currency code",
      "price": Amount,
      "credit":"Credit account balance"
    }
  }
}

---

wgp-domain-delete

Utilice el comando wgp-domain-delete para eliminar un dominio del servicio WEDOS Protection.

Parámetros

• service_id = ID del servicio (obligatorio)
• force = Forzar la eliminación independientemente de los registros de dominio A/AAAA (opcional si existe token para reescribir registros DNS)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2274 = Error interno - falta el parámetro user_id
• 2292 = Dominio no encontrado en esta cuenta de usuario
• 2400 = Error interno
• 2410 = Servicio no encontrado
• 2411 = Token no disponible para reescribir DNS
• 2412 = Petición API fallida para reescribir DNS
• 2413 = Solicitud fallida, el WGP no tiene permiso para actualizar el DNS
• 2414 = El WGP no tiene un token y el usuario no ha configurado el indicador de forzado en la WAPI.

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• wedos_client_id = ID del cliente
• service_id = ID del servicio
• service_type = tipo de servicio
• wdns_data = matriz de actualizaciones IP

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "force": true (forces delete without updating DNS) | false (restores original DNS if able)
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": id,
      "wedos_client_id":"id",
      "service_id":id,
      "service_type":"hosting_wedos_protection",
      "wdns_data":{
        "domain":"domain_name.tld",
        "rows_a":{
          "rem":{
            "removed A record ID":{
              "name":"removed A record name",
              "ttl":"removed A record TTL",
              "rdtype":"A",
              "rdata":"removed A record IP"
            }
          },
          "add":{
            "added A record ID":{
              "name":"added A record name",
              "ttl":"added A record TTL",
              "rdtype":"A",
              "rdata":"added A record IP"
            }
          },
          "stay":[ "list of unchanged addresses" ]
        },
      "rows_aaaa":
        "rem":{
            "removed AAAA record ID":{
              "name":"removed AAAA record name",
              "ttl":"removed AAAA record TTL",
              "rdtype":"AAAA",
              "rdata":"removed AAAA record IP"
            }
          },
          "add":{
            "added AAAA record ID":{
              "name":"added AAAA record name",
              "ttl":"added AAAA record TTL",
              "rdtype":"AAAA",
              "rdata":"added AAAA record IP"
            }
          },
          "stay":[ "list of unchanged addresses" ]
        }
      }
    }
  }
}

---

wgp-domain-delete-order

Use the wgp-domain-delete command to delete a domain order from the WEDOS Protection service. This is useful for deleting services which failed during creation.

This request will not delete existing services. For those, use wgp-domain-delete.

Parámetros

• domain = nombre de dominio (obligatorio)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2274 = Error interno - falta el parámetro user_id
• 2292 = Dominio no encontrado en esta cuenta de usuario
• 2400 = Error interno
• 2410 = Servicio no encontrado
• 2421 = WGP service exists, the domain will not be deleted

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• wedos_client_id = ID del cliente

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete-order",
    "clTRID": "your ID",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete-order",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": id,
      "wedos_client_id":"id"WGP service exists, the domain will not be deleted
    }
  }
}

JSON response (Error – WEDOS Protection service already exists):

{
  "response": {
    "code": 2421,
    "result": "WGP service exists, the domain will not be deleted",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-delete-order"
  }
}

---

wgp-domain-update-subscription

Utilice la solicitud wgp-domain-update-subscription para cambiar el plan o el periodo de facturación del servicio WEDOS Protection.

Parámetros

• service_id = ID del servicio (obligatorio)
• new_variant_id = plan de servicio (obligatorio) – 1 = Inicial, 2 = Avanzado, 3 = Experto
• new_period_id = período de facturación (obligatorio) – 1 = mensual, 4 = anual

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2101 = Parámetros no coincidentes
• 2203 = Period_id no válido
• 2273 = Variante no válida
• 2293 = unable to retrieve credit value
• 2294 = unable to retrieve service price
• 2279 = credit account locked
• 2281 = inactive credit account
• 2282 = unable to pay with credit currency
• 2283 = invalid amount or insufficient remaining credit
• 2284 = invalid credit account contact details
• 2285 = invalid VAT invoicing
• 2286 = credit account – unknown response code
• 2400 = Error Intenral WGP
• 2406 = Dominio/servicio no financiado
• 2408 = Falta variant_id o period_id

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• wedos_client_id = ID del cliente
• service_id = ID del servicio
• service_type = tipo de servicio
• variant_id = ID del plan de servicio
• period_id = ID del periodo de facturación
• sucio = marca de actualización (0 = igual que antes, 1 = cambiado)

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-update-subscription",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID",
      "new_variant_id": "1, 2, or 3",
      "new_period_id": "1, or 4"
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-update-subscription",
    "data":{
      "domain": "domain_name.tld",
      "domain_id": domain ID,
      "wedos_client_id": "customer ID",
      "service_id": service ID,
      "service_type": "service type ID",
      "variant_id": plan ID,
      "period_id": billing period ID,
      "dirty": 0|1
    }
  }
}

---

wgp-domain-retry

Con el comando wgp-domain-retry se repite la solicitud de emisión de un certificado. Puede utilizarlo para resolver el estado error_crt devuelto por el comando wgp-domain-info.

Parametría

• domain = nombre de dominio (obligatorio)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2292 = Dominio no encontrado en esta cuenta de usuario
• 2400 = Error interno
• 4000 = Error interno

Datos de respuesta

• domain = Nombre de dominio
• domain_id = ID de dominio en WGP
• wedos_client_id = ID de cliente

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-retry",
    "clTRID": "your ID",
    "data": {
      "domain": "nazev_domeny.tld"
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-retry",
    "data":{
      "domain": "domain_name.tld",
      "domain_id": domain ID,
      "wedos_client_id": "customer ID"
    }
  }
}

---

wgp-domain-cache-purge

Utilice wgp-domain-cache-purge para purgar la caché de dominio de WEDOS Protection.

Parámetros

• service_id = ID del servicio (obligatorio)
• tipo_servicio = Tipo de servicio (opcional)
  • valores: hosting_wedos_protection (por defecto), hosting_domain
• decaimiento_limitador = Tiempo de bloqueo en segundos (opcional)
  • valor por defecto 5
• Limiter_reset = Limitador de cancelación (opcional)
  • 0 (no, por defecto), 1 (sí)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2101 = Parámetros no coincidentes
• 2274 = error interno - falta user_id
• 2400 = error interno - código de retorno desconocido
• 2406 = dominio/servicio no encontrado
• 2415 = valor del limitador alcanzado
• 4000 = error del sistema

Datos de respuesta

• domain = Nombre de dominio
• domain_id = ID de dominio
• domain_tld = Dominio TLD
• service_id = ID del servicio
• wedos_client_id = ID de cliente
• limiter_available_in = Tiempo en segundos hasta que la función vuelve a estar disponible

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-cache-purge",
    "clTRID": "own ID code",
    "data": {
      "service_id": Service ID,
      "service_type": "service type code (optional)",
      "limiter_decay": limiter timeout (in seconds, optional),
      "limiter_reset": 0|1 (optional)
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command": "wgp-domain-cache-purge",
    "data":{
      "domain":"domain_name.tld",
      "domain_id": domain ID,
      "domain_tld":"tld",
      "wedos_client_id":"customer account ID"
    }
  }
}

---

wgp-domain-template-replicate

Utilice la petición wgp-domain-template-replicate para cambiar la configuración del dominio de destino según el dominio de plantilla seleccionado.

Parámetros

• service_id - ID del servicio (obligatorio)
• template_domain_id - ID del dominio de la plantilla de destino (obligatorio)
• tipo_servicio - tipo de servicio (opcional)
  • valores: hosting_domain, hosting_wedos_protection

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2101 = Parámetros no coincidentes
• 2400 = Error WGP interno
• 2401 = No se puede aplicar la plantilla al dominio
• 2402 = Plantilla de dominio no válida
• 2403 = No coinciden la plantilla de dominio y el usuario
• 2404 = Plantilla de dominio y plan de dominio no coinciden
• 2405 = Dominio de plantilla diario alcanzado
• 2406 = Dominio/servicio no encontrado
• 2407 = Dominio de plantilla no encontrado
• 4000 = Error interno

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• service_id = ID del servicio
• service_type = tipo de servicio
• template_domain_id = ID del dominio de la plantilla
• replications_count = recuento de réplicas realizadas
• replications_limit = número máximo de réplicas

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-template-replicate",
    "clTRID": "your ID",
    "data": {
      "service_id": service ID,
      "template_domain_id": template domain ID,
      "service_type": "hosting_domain, or hosting_wedos_protection (optional)"
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-template-replicate",
    "data":{
      "domain":"domain_namey.tld",
      "domain_id": domain ID,
      "service_id": service ID,
      "service_type": "service type",
      "template_domain_id": template domain ID,
      "replications_count": replication count,
      "replications_limit": replication limit
    }
  }
}

---

wgp-domain-templates-list

Utilice la petición wgp-domain-templates-list para recuperar una lista de dominios de plantilla para el plan de protección WEDOS seleccionado.

Parámetros

• variant_id = ID del plan (obligatorio)
• per_page = Número de registros por página (por defecto = 15, obtener todos los registros = -1) (opcional)
• page = Número de página (por defecto = 1) (opcional)
• locale = Idioma (por defecto = en, soportado = cs, en) (opcional)
• search = Búsqueda por columnas custom_name, name (opcional)

Valores de retorno

• 1000 = OK
• 2100 = Falta el parámetro requerido
• 2400 = error interno
• 4000 = error interno

Datos de respuesta

• datos = Plantilla de lista de dominios
  • id = ID del dominio de la plantilla
  • custom_name = Nombre de dominio de la plantilla (establecido por el usuario)
  • name = Nombre de dominio de la plantilla (sistema)
  • url = URL del dominio de la plantilla
• first_page_url = URL de la primera página de la lista
• desde = Inicio de la paginación
• last_page = Número de la última página
• last_page_url = URL de la última página de la lista
• enlaces = Pagination link arrary
  • url = URL del enlace
  • label = Etiqueta del botón
  • activo = null|1
• next_page_url = URL de la página siguiente
• path = URL de la lista de dominios de la plantilla
• per_page = Número de entradas por página
• prev_page_url = URL de la página anterior
• to = Fin de la paginación
• total = Número total de páginas

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-templates-list",
    "clTRID": "your ID",
    "data": {
      "variant_id": plan ID 1 = Start, 2 = Advanced, 3 = Expert,
      "per_page": entries per page (optional),
      "page": page nr. (optional),
      "locale": "cs, or en (optional)",
      "search": "Search by custom_name, name (optional)"
    }
  }
}

Respuesta JSON (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wgp-domain-templates-list",
    "data":{
      [
        {
          "id": Template domain ID,
          "custom_name":"termplate domain user name",
          "name":"system-name.template",
          "url":"https:\/\/template.domain.url\/system-name.template"
        }
      ],
      "first_page_url":"https:\/\/first.page.url",
      "from": 1st page number,
      "last_page": last page number,
      "last_page_url":"https:\/\/last.page.url",
      "links":[
        {
          "url": "https:\/\/page.url",
          "label":"Button label",
          "active": null|1
        }
      ],
      "next_page_url": "https:\/\/next.page.url",
      "path":"https:\/\/list.url",
      "per_page": entries per page,
      "prev_page_url":"https:\/\/previous.page.url",
      "to": last list item,
      "total": total page count
    }
  }
}

---

wgp-services-list

Con la petición wgp-services-list, puede recuperar una lista de dominios con el servicio WEDOS Protection. Puede filtrar por estado.

Parámetros

• status = estado del servicio (opcional)

Valores de retorno

• 1000 = OK
• 2206 = Solicitud no válida - error interno

Datos de respuesta

• ID = ID del registro de dominio
• nombre = nombre de dominio
• estado = estado del servicio
• expiración = fecha de expiración del servicio WG

Plantillas

Solicitud JSON

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-services-list",
    "clTRID": "own ID code",
    "data": {
      "status": "active, expired, disabled or deleted"
    }
  }
}

Respuesta JSON (OK)

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF time",
    "clTRID": "own ID code",
    "svTRID": "server ID code",
    "command":"wgp-services-list",
    "data":{
      "service ID in the system":{
        "ID":"service ID in the system",
        "domain":"domain_name.tld",
        "status":"service status",
        "expiration": "expiration date YYYY-MM-DD"
    }
  }
}