API de DonDominio

    API DonDominio

    Manual de usuario de la API
    Versión 1.0.20 - 15/07/2021
    DonDominio

    1 Conceptos generales

    Importante: La API y su documentación están sujetas a cambios. Recomendamos consultar periódicamente la documentación online de la API DonDominio para evitar posibles problemas o incompatibilidades.

    Esta guía de referencia está destinada a ayudarte a comprender cómo acceder y hacer uso de nuestra API, en ella encontrarás los detalles para realizar correctamente las peticiones, la estructura básica de nuestra API, los códigos de error que obtendrás y el formato en el que recibirás nuestras respuestas. Rogamos hagas uso de la API únicamente si tienes experiencia en este tipo de entornos.

    1.1 Antes de empezar

    El uso de la API DonDominio está restringido a cuentas de cliente previamente autorizadas y que hayan pasado los controles de calidad del equipo de DonDominio.

    El servicio de API está restrigido a una serie de direcciones IP. Cada una de las direcciones IP debe ser dada de alta en el sistema para poder acceder a la API, además, será necesario el uso de unas credenciales de acceso ( apiuser y apipasswd ) que obtendrás contactando con nuestro equipo de soporte.
    En la mayoría de peticiones será necesario enviar las credenciales de acceso.

    1.2 Uso destinado de esta API

    El uso de la API de DonDominio está destinado a la creación de aplicaciones web para la administración de dominios y carteras de dominios propias.

    Queda terminantemente prohibido el uso de la API para consultas y/o peticiones masivas (captura de dominios, consultas de disponibilidad masivas, ...), cualquier tipo de uso masivo es detectado en tiempo real por parte de nuestro sistema, provocando el bloqueo temporal del nombre de usuario y contraseña de acceso a la API.

    El abuso repetido podrá conllevar al bloqueo y/o cancelación de la cuenta de cliente.

    1.3 Límites

    Tanto el número de accesos simultáneos a la API, como el número de operaciones y errores generados se encuentran debidamente monitorizados y son limitados para evitar un mal uso de nuestros sistemas. Superar estos límites establecidos puede suponer el bloqueo temporal del nombre de usuario y contraseña de acceso a la API.

    Encontrarás más información en las Políticas de uso de la aplicación.

    2 Interfaz Simple-POST

    Los accesos a la API se realizan mediante el protocolo HTTPS. Los diferentes parámetros deben enviarse mediante POST (los parámetros enviados a través de GET serán ignorados). Se recomienda realizar el check del certificado SSL del servidor para verificar que la conexión se está realizando contra el servidor correcto.

    Las repuestas se enviarán en formato JSON (JavaScript Object Notation).

    2.1 Datos necesarios para la conexión

    URL: https://simple-api.dondominio.net[:443]/[APICALL]/
    apiuser: *******
    apipasswd: *******
    IP: IP Address

    Para realizar una petición, por ejemplo, tool/hello, debe realizarse un post a la URI https://simple-api.dondominio.net/tool/hello/.

    Ejemplo de petición válida:

    Petición:

    POST /tool/hello/
    
    param1=value1&param2=value2

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/hello",
        "version": "1.0.20",
        "responseData": {
            "ip": "127.0.0.1",
            "lang": "en",
            "version": "1.0.20"
        }
    }

    Si el parámetro success tiene el valor de true ( errorCode = 0 ), significa que la petición es correcta y el responseData contine los datos solicitados. Si el success es false, significa que algo ha fallado.

    Ejemplo de petición errónea:

    Petición:

    POST /tool/requestinvalid/

    Ejemplo de respuesta:

    {
        "success": false,
        "errorCode": 102,
        "errorCodeMsg": "Object action invalid",
        "action": "tool\/requestinvalid",
        "version": "1.0.20",
        "messages": [
            "invalid object\/action"
        ],
        "responseData": []
    }

    2.2 Credenciales

    Se deben enviar las credenciales de acceso para la peticiones que así lo requieran, éstas serán enviadas mediante POST con los siguientes parámetros (clave/valor en formato application/x-www-form-urlencoded):

    POST /requesturi/
    
    apiuser=YOURAPIUSER&apipasswd=YOURAPIPASS

    2.3 Parámetros comunes y formato de salida

    Hay algunos parámetros que son comunes en prácticamente todas las peticiones. Por ejemplo, en todas las peticiones que se requiera estar autenticado, será necesario enviar los parámetros apiuser y apipasswd.
    Es posible modificar el formato de respuesta mediante los parámetros output-format y output-pretty. El primero sirve para cambiar el formato de la respuesta y el segundo para aplicarle un formato más legible. Por defecto, se usa json en línea, que es lo más rápido.

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    output-format Opcional json Formato de la respuesta.
    Valores posibles: json, xml
    output-pretty Opcional false Parsea el formato de salida

    Ejemplo con output-format = json y output-pretty = false

    Ejemplo de respuesta:

    {"success":true,"errorCode":0,"errorCodeMsg":"","action":"tool\/hello","version":"1.0.20","responseData":{"ip":"37.152.93.46","lang":"en","version":"1.0.20"}}

    Ejemplo con output-format = xml y output-pretty = false

    Ejemplo de respuesta:

    <?xml version="1.0" encoding="UTF-8"?>
    <data><success>1</success><errorCode>0</errorCode><errorCodeMsg></errorCodeMsg><action>tool/hello</action><version>1.0.20</version><responseData><ip>37.152.93.46</ip><lang>en</lang><version>1.0.20</version></responseData></data>

    Ejemplo con output-format = xml y output-pretty = true

    Ejemplo de respuesta:

    <?xml version="1.0" encoding="UTF-8"?>
    <data>
      <success>1</success>
      <errorCode>0</errorCode>
      <errorCodeMsg></errorCodeMsg>
      <action>tool/hello</action>
      <version>1.0.20</version>
      <responseData>
        <ip>37.152.93.46</ip>
        <lang>en</lang>
        <version>[#VERSION]</version>
      </responseData>
    </data>

    2.4 Módulos disponibles

    Módulo Título Descripción
    /tool/ Herramientas Herramientas varias de ayuda
    /account/ Cuenta Acciones sobre la cuenta de cliente/api
    /domain/ Dominios Acciones sobre dominios
    /contact/ Contactos Acciones sobre contactos de dominios
    /service/ Alojamiento Accciones sobre alojamientos compartidos y servicios de correo
    /ssl/ Certificados SSL Acciones sobre certificados SSL

    3 Modulo: Tool

    El módulo Tool permite el acceso a diferentes herramientas.

    Acciones disponibles:

    Acción Credenciales Descripción
    /tool/hello/ Requeridas Comprobar la disponibilidad y funcionamiento de la API
    /tool/idnconverter/ Requeridas Conversor IDNA/Unicode/Punycode
    /tool/domainsuggests/ Requeridas Sugerencias de disponibilidad de dominios alternativos
    /tool/gettable/ Requeridas Obtener tablas usadas por la aplicación
    /tool/dig/ Requeridas DIG (Domain Information Groper) - Herramienta de comprobación de servidores DNS
    /tool/zonecheck/ Requeridas Verificar si un dominio cumple los requisitos de su TLD

    3.1 Hello ( tool/hello/ )

    Uso: Permite verificar que la conexión y la API funcionan de forma correcta.

    Petición:

    POST /tool/hello/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario

    Descripción de los campos de respuesta:

    Campo Descripción
    ip Dirección IP de conexión
    lang Idioma de la API
    version Versión de la API

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/hello",
        "version": "1.0.20",
        "responseData": {
            "ip": "127.0.0.1",
            "lang": "en",
            "version": "1.0.20"
        }
    }

    3.2 IDN Converter ( tool/idnconverter/ )

    Uso: Convierte una cadena/dominio entre unicode y punicode (formato IDNA)

    Petición:

    POST /tool/idnconverter/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    query Requerido Query/Dominio a covertir Punycode <> Unicode

    Descripción de los campos de respuesta:

    Campo Descripción
    query Petición realizada
    unicode Cadena/dominio en formato Unicode
    punycode Cadena/dominio en formato Punycode

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/idnconverter",
        "version": "1.0.20",
        "responseData": {
            "query": "espa\u00f1a.com", /* españa.com */
            "unicode": "espa\u00f1a.com",
            "punycode": "xn--espaa-rta.com"
        }
    }

    3.3 Domain Suggests ( tool/domainsuggests/ )

    Uso: Busca a partir de una palabra sugerencias de dominios y su disponibilidad.
    Un uso abusivo del comando domain/check/ puede llevar al baneo temporal o total de la cuenta.

    Petición:

    POST /tool/domainsuggests/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    query Requerido Palabra o dominio sobre el que buscar sugerencias
    language Opcional es Idioma de las sugerencias. Diponibles: es, en, zh, fr, de, kr, pt, tr
    tlds Opcional com,net TLDs donde buscar las sugerencias. Deben estar separados por comas.
    TLDs disponibles: com,net,tv,cc

    Descripción de los campos de respuesta:

    Campo Descripción
    query Petición realizada
    suggests/word/tld Bool Indica la disponibilidad del dominio word.tld

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/domainsuggests",
        "version": "1.0.20",
        "responseData": {
            "query": "coches",
            "suggests": {
                "coches": {
                    "es": false,
                    "com": false,
                    "net": false
                },
                "cochesonline": {
                    "es": false,
                    "com": false,
                    "net": true
                },
                "loscoches": {
                    "es": false,
                    "com": false,
                    "net": true
                }
                    /*,...*/
        }
    }

    3.4 Get Table ( tool/gettable/ )

    Uso: Obtener diferentes tablas que pueden ser necesarias en algunos módulos de la API.

    Petición:

    POST /tool/gettable/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    tableType Requerido Tipo de tabla a obtener
    countries: Listado de countryCodes y nombres de paises.
    es_juridic: Códigos de formas júridicas para contactos tipo organización de España.

    Descripción de los campos de respuesta:

    Campo Descripción
    items Array con los items de las tablas

    Ejemplo de tableType = country

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/gettable",
        "version": "1.0.20",
        "responseData": {
            "items": [
                {
                    "code": "AD",
                    "name": "Andorra"
                },
                {
                    "code": "AE",
                    "name": "United Arab Emirates"
                },
                {
                    "code": "AF",
                    "name": "Afghanistan"
                }
                /*
                ,{ ....  }
                */
                ]
        }
    }

    Ejemplo de tableType = es_juridic

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/gettable",
        "version": "1.0.20",
        "responseData": {
            "items": [
                {
                    "code": "39",
                    "name": "Agrupaci\u00f3n de Inter\u00e9s Econ\u00f3mico"
                },
                {
                    "code": "47",
                    "name": "Asociaci\u00f3n"
                },
                {
                    "code": "59",
                    "name": "Asocicaci\u00f3n Deportiva"
                }
                /*
                ,{ ....  }
                */
                ]
        }
    }

    3.5 DIG ( tool/dig/ )

    Uso: DIG o Domain Information Groper es una utilidad para consultar servidores DNS. En caso de que tu dominio no resuelva correctamente podrás comprobar fácilmente a qué es debido, ayudándote a reducir el tiempo durante el cual la web no estará operativa.

    Petición:

    POST /tool/dig/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    query Requerido Dominio/consulta
    type Requerido Tipo de consulta. Valores posibles: A, AAAA, ANY, CNAME, MX, NS, SOA, TXT, CAA
    nameserver Requerido Servidor DNS o dirección IP

    Descripción de los campos de respuesta:

    Campo Descripción
    query Petición realizada
    nameserver Servidor DNS o su dirección IP
    type Tipo de consulta
    result Resultado de la consulta en formato texto

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/dig",
        "version": "1.0.20",
        "responseData": {
            "query": "microsoft.com",
            "nameserver": "8.8.8.8",
            "type": "SOA",
            "result": ";; Got answer:\n;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 62615\n;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0\n\n;; QUESTION SECTION:\n;microsoft.com.\t\t\tIN\tSOA\n\n;; ANSWER SECTION:\nmicrosoft.com.\t\t3599\tIN\tSOA\tns1.msft.net. msnhst.microsoft.com. 2015080701 7200 600 2419200 3600\n\n"
    
        }
    }

    3.6 ZoneCheck( tool/zonecheck/ )

    Uso: Comprueba la zona de un dominio para comprobar si cumple unos requisitos mínimos

    Petición:

    POST /tool/zonecheck/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido Nombre de dominio
    nameservers Requerido Servidores DNS ( min: 2 )

    Descripción de los campos de respuesta:

    Campo Descripción
    domain Nombre de dominio
    nameservers Servidor DNS
    result Resultado de la consulta
    result/zonepass Indica si ha pasado el chequeo de zona
    result/report Informe del chequeo en formato texto

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/zonecheck",
        "version": "1.0.20",
        "responseData": {
            "domain": "dondominio.fr",
            "nameservers": [
                "ns5.dondominio.com",
                "ns2.dondominio.com"
            ],
            "result": {
                "zonepass": true,
                "report": "ZONE  : dondominio.fr\nNS <= : ns5.dondominio.com [37.152.88.14]\nNS    : ns2.dondominio.com [178.33.146.32]\n\n       _______________\n     ,---------------.|\n~~~~ |    warning    || ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n     `---------------'\nw> [TEST can deliver email to 'postmaster']: Connection refused - connect(2)\n=> generic\n\n==> SUCCESS (but 1 warning(s))\n"
            }
        }
    }

    4 Modulo: Account

    El módulo account permite el acceso a las diferentes opciones sobre la cuenta.

    Acciones disponibles:

    Acción Credenciales Descripción
    /account/info/ Requeridas Obtiene información de la cuenta/API
    /account/promos/ Required Listado de las actuales promociones
    /account/zones/ Requeridas Obtiene información de las zonas/TLDs disponibles

    4.1 Info ( account/info/ )

    Uso: Permite obtener los datos de la cuenta, como el saldo disponible, etc...

    Petición:

    POST /account/info/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario

    Descripción de los campos de respuesta:

    Campo Descripción
    clientName Nombre del cliente
    apiuser Nombre de usuario de la API
    balance Saldo en cuenta disponible
    threshold Saldo umbral de aviso
    currency (float) Moneda del saldo en cuenta
    ip Dirección IP de conexión

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "account\/info",
        "version": "1.0.20",
        "responseData": {
            "clientName": "clientX",
            "apiuser": "YOURAPIUSER",
            "balance": 124.0,
            "threshold": 30.0,
            "currency": "EUR",
            "ip": "127.0.0.1"
        }
    }

    4.2 Promos ( account/promos/ )

    Uso: Listado de las actuales promociones.

    Petición:

    POST /account/promos/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario

    Descripción de los campos de respuesta:

    Campo Descripción
    promo Identificación de la promoción
    type Tipo de promoción
    action A que afecta la promoción
    price Precio de la promoción
    tsIni Fecha de inicio de la promoción
    tsEnd Fecha de final de la promoción
    tld (Si type=domain) TLD del dominio afectado
    productID (Si type=ssl) ID del producto SSL afectado

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "account\/promos",
        "version": "1.0.20",
        "responseData": [
            {
                "promo": "LSxDNFErMyhQLDM8TytXIVI7UGBgCmAK",
                "type": "domain",
                "action": "create",
                "price": 4.95,
                "tsIni": "2017-01-01 00:00:00",
                "tsEnd": "2021-12-31 23:59:00",
                "tld": "pro"
            },
            {
                "promo": "MSxTQFcrMyhQLEMkTytXLVM7IlVNODdEYApgCg==",
                "type": "ssl",
                "action": "create",
                "price": 28,
                "tsIni": "2021-05-03 00:00:00",
                "tsEnd": "2021-07-03 00:00:00",
                "productID": "57"
            }
        ]
    }

    4.3 Zones ( account/zones/ )

    Uso: Permite obtener las zonas/TLDs disponibles

    Petición:

    POST /account/zones/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 100 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    tld Opcional Filtra por el TLD
    tldtop Opcional Filtra por el TLD de nivel superior

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    zones/tld TLD
    zones/tldtop TLD de nivel 1
    zones/authcodereq (bool) Indica si el TLD require un Authcode para las transferencias
    zones/requirements Si existe, indica los requerimientos especiales del TLD/Zona
    zones/create Si existe, indica que el TLD permite el registro
    zones/create/price Precio del registro/año
    zones/create/years Años permitidos del registro
    zones/create/inPromo (bool) Indica si el TLD dispone de una promo
    Sólo cuando es true
    zones/renew Si existe, indica que el TLD permite la renovación
    zones/renew/price Precio de la renovación/año
    zones/renew/years Años permitidos de la renovación
    zones/renew/inPromo (bool) Indica si el TLD dispone de una promo
    Sólo cuando es true
    zones/transfer Si existe, indica que el TLD permite la transferencia
    zones/transfer/price Precio de la transferencia
    zones/transfer/years Años permitidos de la operación de transferencia
    zones/transfer/inPromo (bool) Indica si el TLD dispone de una promo
    Sólo cuando es true

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "account\/zones",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 100,
                "results": 1,
                "total": 1
            },
            "zones": [
                {
                    "tld": "green",
                    "tldtop": "green",
                    "authcodereq": true,
                    "create": {
                        "price": 12.95,
                        "years": "1",
                        "inPromo": true
                    },
                    "renew": {
                        "price": 52.95,
                        "years": "1,2,3,4,5,6,7,8,9,10"
                    },
                    "transfer": {
                        "price": 52.95,
                        "years": "1"
                    }
                }
            ]
        }
    }

    5 Modulo: Domain

    El módulo domain permite el acceso a las diferentes opciones sobre los dominios.

    Acciones disponibles:

    Acción Credenciales Descripción
    domain/check Requeridas Disponibilidad de un dominio para registrar
    domain/checkfortransfer Requeridas Disponibilidad de un dominio para transferir
    domain/create Requeridas Registro de un dominio
    domain/transfer Requeridas Transferencia de un dominio
    domain/transferrestart Requeridas Reinicio del proceso de transferencia
    domain/update Requeridas Actualización de los datos de un dominio
    domain/updatenameservers Requeridas Actualización de los servidores DNS de un dominio
    domain/updatecontacts Requeridas Actualización de los datos de los contactos de un dominio
    domain/gluerecordcreate Requeridas Crear un DNS asociado a un dominio
    domain/gluerecordupdate Requeridas Actualizar un DNS asociado a un dominio
    domain/gluerecorddelete Requeridas Borrar un DNS asociado a un dominio
    domain/list Requeridas Buscar/filtrar/listar los dominios de la cuenta
    domain/getinfo Requeridas Obtener datos de un dominio
    domain/getauthcode Requeridas Obtener el authcode de un dominio
    domain/getnameservers Requeridas Obtener los servidores DNS de un dominio
    domain/getgluerecords Requeridas Obtener los gluerecords (DNS Asociados) de un dominio
    domain/getdnssec Requeridas Obtener las entradas DNSSEC asociados a un dominio
    domain/dnsseccreate Requeridas Añadir una entrada DNSSEC
    domain/dnssecdelete Requeridas Borrar una entrada DNSSEC
    domain/renew Requeridas Renovar un dominio
    domain/whois Requeridas Consulta de Whois público de un dominio
    domain/resendverificationmail Requeridas Reenviar el email de verificación de los datos del contacto titular
    domain/resendfoamail Requeridas Reenviar el email de autorización del FOA al contacto titular
    domain/resetfoa Requeridas Reiniciar el proceso de autorización del dominio
    domain/gethistory Requeridas Historial del dominio
    domain/listdeleted Requeridas Dominios borrados

    5.1 Check ( domain/check/ )

    Uso: Realizar una consulta de disponibilidad de un dominio para saber si se puede registrar o no.
    Un uso abusivo del comando domain/check/ puede llevar al baneo temporal o total de la cuenta.

    Petición:

    POST /domain/check/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido Dominio en formato punycode

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio (formato UTF8)
    punycode Nombre del dominio en formato IDNA
    tld TLD del dominio
    available (bool) Indica si está disponible para su registro
    premium (bool) Indica si el dominio es premium. Al registrar un dominio premium debe enviarse este flag
    price (float) Precio por año de registro
    currency Moneda

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/check",
        "version": "1.0.20",
        "responseData": {
            "domains": [
                {
                    "name": "exampledomain-001.com",
                    "punycode": "exampledomain-001.com",
                    "tld": "com",
                    "available": true,
                    "premium": false,
                    "price": 9.95,
                    "currency": "EUR"
                }
            ]
        }
    }

    5.2 Check For Transfer ( domain/checkfortransfer/ )

    Uso: Realizar una consulta de disponibilidad de un dominio para saber si se puede transferir

    Petición:

    POST /domain/checkfortransfer/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido Dominio en formato punycode

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio (formato UTF8)
    punycode Nombre del dominio en formato IDNA
    tld TLD del dominio
    transferavail (bool) Indica si el dominio se puede transferir
    transfermsg Mensajes extras indicando porque no se puede transferir
    price (float) Precio por año de registro
    currency Moneda

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/checkfortransfer",
        "version": "1.0.20",
        "responseData": {
            "domains": [
                {
                    "name": "example01.com",
                    "punycode": "example01.com",
                    "tld": "com",
                    "transferavail": true,
                    "transfermsg": [],
                    "price": 9.95,
                    "currency": "EUR"
                }
            ]
        }
    }

    5.3 Create ( domain/create/ )

    Uso: Creación/registro de un dominio

    Recomendaciones: Comprobar antes de realizar una petición de domain/create, al disponibilidad mediante un domain/check

    Petición:

    POST /domain/create/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido Nombre del dominio
    period Opcional Min years (normalmente 1 año) Número de años de registro del dominios (por defecto el número mínimo de años)
    premium Opcional false Debe ser premium = true para registrar dominios premium
    nameservers Opcional parking Listado de servidores DNS
    Si el valor es parking, se asignará el servicio de Redirección y Parking.
    Sino, debe especificarse una lista de DNS (min. 2, máx. 7) separados por coma:
    ns1.dns.com,ns2.dns.com
    ownerContact[Data] Requerido Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] Opcional Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] Opcional Datos del contacto de facturación. Si no se especifica se aplicarán los mismos datos del contacto administrativo

    5.3.1 Especificar contactos

    Los datos de ownerContact[Data], techContact[Data], techContact[Data] y/o billingContact[Data], pueden especificarse de dos formas diferentes:

    (1) Especificando el identificador del contacto: (ejemplo para owner)

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerContactID Requerido Identificador del contacto en DonDominio. Ejemplo: XXX-23423

    (2) Especificando todos los datos necesarios: (ejemplo para owner)
    En este caso, no se debe especificar el ownerContactID, o estos datos serán ignorados.

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerContactType Requerido Tipo de contacto individual o organization
    ownerContactFirstName Requerido Nombre del contacto
    ownerContactLastName Requerido Apellidos del contacto
    ownerContactOrgName Requerido
    if ownerContactType = organization
    Nombre de la empresa
    ownerContactOrgType Requerido
    if ownerContactType = organization
    y ownerCountry = ES
    Tipo de organización española (Ver tabla)
    ownerContactIdentNumber Requerido Número de identificación fiscal, VAT Number, etc...
    ownerContactEmail Requerido Correo electrónico del contacto
    ownerContactPhone Requerido Número de teléfono del contacto en formato +DD.DDDDDDDD
    ownerContactFax Opcional Número de fax en formato +DD.DDDDDDDDD
    ownerContactAddress Requerido Dirección del contacto
    ownerContactPostalCode Requerido Código Postal del contacto
    ownerContactCity Requerido Ciudad/Localidad del contacto
    ownerContactState Requerido Estado/Provincia del contacto
    ownerContactCountry Requerido (String 2 letras) Código de país (Ver tabla)

    El resto de contactos se pueden especificar cambiando el prefijo de los parámetros de owner a admin, tech o billing.

    5.3.2 Respuesta

    Descripción de los campos de respuesta:

    Campo Descripción
    billing/total Coste total de la operación
    billing/currency Moneda de la operacion
    domains/name Nombre del dominio
    domains/status Estado del dominio
    domains/tld TLD del dominio
    domains/tsExpir Fecha de expiración del dominio
    domains/domainID Identificador del dominio
    domains/period Periodo de registro
    domains/inPromo (bool) Indica si el TLD dispone de una promo
    Sólo cuando es true

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/create",
        "version": "1.0.20",
        "responseData": {
            "billing": {
                "total": 12.04,
                "currency": "EUR"
            },
            "domains": [
                {
                    "name": "myexample.com",
                    "status": "register-init",
                    "tld": "com",
                    "tsExpir": "",
                    "domainID": 45762358,
                    "period": 1
                }
            ]
        }
    }

    5.3.3 Parámetros especificos para algunos dominios

    Dominios .aero

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    aeroId Requerido ENS Identifier. Más información en ENS Aero ID
    aeroPass Requerido ENS Password
    Dominios .barcelona, .madrid, .cat, .pl, .scot, .eus, .gal, .quebec, .radio

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    domainIntendedUse Requerido Intención de uso del dominio
    Dominios .ee

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Dominios .fi

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Dominios .fr, .re, .yt, .pm, .wf, .tf

    Nota: En el caso de que el contacto titular sea una organización, por defecto se registrará el dominio asociado al VAT Number ( ownerIdentNumber ). Se puede asociar el dominio a un número SIREN ( especificando el frSirenNumber ) o a una número de marca registrada ( especificando frTradeMark ).

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    frTradeMark Opcional Si el contacto titular es una organización/empresa, y se quiere registrar la marca registrada ( se debe especificar el numero de marca registrada frTradeMark = TradeMarkNumber
    frSirenNumber Opcional Si se quiere registrar el dominio con el numero SIREN del contacto titular
    Dominios .hk

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Domnios .law, .abogado

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    lawaccid Requerido Número de acreditación del solicitante
    lawaccbody Requerido Nombre oficial del regulador
    lawaccyear Requerido Año de la acreditación
    lawaccjurcc Requerido País de la jurisdicción de la acreditación
    lawaccjurst Requerido Estado/Provincia de la jurisdicción de la acreditación
    Dominios .jobs

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    jobsOwnerIsAssocMember Opcional false (bool) Flag que indica si el contacto titular es miembro asociado del SHRM
    jobsOwnerWebsite Requerido Website del contacto titular
    jobsOwnerTitle Opcional Titulo del contacto titular
    jobsOwnerIndustrytype Opcional Tipo de comercio del contacto titular
    jobsAdminIsAssocMember Opcional false (bool) Flag que indica si el contacto administrivo es miembro asociado del SHRM
    jobsAdminWebsite Requerido Website del contacto administrativo
    jobsAdminTitle Opcional Titulo del contacto administrativo
    jobsAdminIndustrytype Opcional Tipo de comercio del contacto administrativo
    jobsTechIsAssocMember Opcional false (bool) Flag que indica si el contacto técnico es miembro asociado del SHRM
    jobsTechWebsite Requerido Website del contacto técnico
    jobsTechTitle Opcional Titulo del contacto técnico
    jobsTechIndustrytype Opcional Tipo de comercio del contacto técnico
    jobsBillingIsAssocMember Opcional false (bool) Flag que indica si el contacto de facturación es miembro asociado del SHRM
    jobsBillingWebsite Requerido Website del contacto de facturación
    jobsBillingTitle Opcional Titulo del contacto de facturación
    jobsBillingIndustrytype Opcional Tipo de comercio del contacto de facturación
    Dominios .lawyer, .attorney, .dentist, .airforce, .army, .navy

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    coreContactInfo Requerido Información de contacto de los órganos relevantes de tu industria, para la notificación de quejas o abuso.
    Dominios .ltda

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ltdaAuthority Opcional Autoridad que certifica la profesión del titular
    ltdaLicenseNumber Opcional Número de licencia del titular
    Dominios .moscow

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Dominios .my

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Dominios .ru

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    ruIssuer Requerido
    if ownerContactType = individual
    Nombre del emisor de la identificación del titular
    ruIssuerDate Requerido
    if ownerContactType = individual
    Fecha de emisión de la identificación del titular
    Dominios .vn

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Dominios .xxx

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    xxxClass Requerido Tipo de usuario en la comunidad .XXX.
    default: No miembro de la comunidad .XXX.
    membership: Miembro de la comunidad .XXX
    nonResolver: No quiero que el dominio resuelva las DNS.
    xxxName Requerido
    if xxxClass = default
    Nombre y apellidos para el registro en la comunidad .XXX
    xxxEmail Requerido
    if xxxClass = default
    Correo electrónico para el registro en la comunidad .XXX
    xxxId Requerido
    if xxxClass = membership
    Identificador ICM Registry ( comunidad .XXX ID )

    5.4 Transfer ( domain/transfer/ )

    Uso: Transferencia de un dominio

    Recomendaciones: Comprobar antes de realizar una petición de domain/transfer, al disponibilidad mediante un domain/checkfortransfer

    Petición:

    POST /domain/transfer/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido Nombre del dominio
    nameservers Opcional parking Listado de servidores DNS
    Si el valor es parking, se asignará el servicio de Redirección y Parking.
    Si el valor es keepns, se mantendrán las DNS actuales del dominio.
    Sino, debe especificarse una lista de DNS (min. 2, máx. 7) separados por coma:
    ns1.dns.com,ns2.dns.com
    authcode Opcional El authcode del dominio en caso necesario.
    foacontact Opcional owner Contacto al que se envia el correo de FOA (Valores posibles owner o admin )
    ownerContact[Data] Requerido Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] Opcional Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo

    Los datos de los contactos pueden especificarse de la misma forma que una petición domain/create.

    Descripción de los campos de respuesta:

    Campo Descripción
    billing/total Coste total de la operación
    billing/currency Moneda de la operacion
    domains/name Nombre del dominio
    domains/status Estado del dominio
    domains/tld TLD del dominio
    domains/tsExpir Fecha de expiración del dominio
    domains/domainID Identificador del dominio
    domains/inPromo (bool) Indica si el TLD dispone de una promo
    Sólo cuando es true

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/create",
        "version": "1.0.20",
        "responseData": {
            "billing": {
                "total": 12.04,
                "currency": "EUR"
            },
            "domains": [
                {
                    "name": "myexample.com",
                    "status": "register-init",
                    "tld": "com",
                    "tsExpir": "",
                    "domainID": 45762358,
                    "period": 1
                }
            ]
        }
    }

    5.4.1 Parámetros especificos para algunos dominios

    Dominios .jobs

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    jobsOwnerIsAssocMember Opcional false (bool) Flag que indica si el contacto titular es miembro asociado del SHRM
    jobsOwnerWebsite Requerido Website del contacto titular
    jobsOwnerTitle Opcional Titulo del contacto titular
    jobsOwnerIndustrytype Opcional Tipo de comercio del contacto titular
    jobsAdminIsAssocMember Opcional false (bool) Flag que indica si el contacto administrivo es miembro asociado del SHRM
    jobsAdminWebsite Requerido Website del contacto administrativo
    jobsAdminTitle Opcional Titulo del contacto administrativo
    jobsAdminIndustrytype Opcional Tipo de comercio del contacto administrativo
    jobsTechIsAssocMember Opcional false (bool) Flag que indica si el contacto técnico es miembro asociado del SHRM
    jobsTechWebsite Requerido Website del contacto técnico
    jobsTechTitle Opcional Titulo del contacto técnico
    jobsTechIndustrytype Opcional Tipo de comercio del contacto técnico
    jobsBillingIsAssocMember Opcional false (bool) Flag que indica si el contacto de facturación es miembro asociado del SHRM
    jobsBillingWebsite Requerido Website del contacto de facturación
    jobsBillingTitle Opcional Titulo del contacto de facturación
    jobsBillingIndustrytype Opcional Tipo de comercio del contacto de facturación
    Dominios .ru

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    ownerDateOfBirth Requerido
    if ownerContactType = individual
    Fecha de nacimiento del titular
    ruIssuer Requerido
    if ownerContactType = individual
    Nombre del emisor de la identificación del titular
    ruIssuerDate Requerido
    if ownerContactType = individual
    Fecha de emisión de la identificación del titular

    5.5 Transfer Restart ( domain/transferrestart )

    Uso: Reinicio del proceso de transferencia. Permite poner un nuevo authcode en caso necesario.

    Petición:

    POST /domain/transferrestart/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    authcode Opcional El authcode del dominio en caso necesario.
    foacontact Opcional owner Contacto al que se envia el correo de FOA (Valores posibles owner o admin )

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/transferrestart",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.6 Update ( domain/update/ )

    Uso: Modificación de los parámetros de un dominios, contactos, nameservers, bloqueos, bloqueos de transferencia, etc..

    Petición:

    POST /domain/update/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    updateType Requerido Tipo de información a actualizar
    contact: Modificación de contatos
    nameservers: Modificación de los servidores DNS
    transferBlock: Activación/Desactivación del bloqueo de transferencia
    block: Activación/Desactivación del bloqueo de modificaciones
    whoisPrivacy: Activación/Desactivación del servicio de WhoisPrivacy
    renewalMode: Cambio en el modo de renovación
    tag: Cambio de las etiquetas de un dominio
    viewWhois: Activación/Desactivación de la visualización de datos en el Whois
    updateType = contact
    ownerContact[Data] Opcional Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] Opcional Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    updateType = nameservers
    nameservers Requerido Listado de servidores DNS
    Si el valor es default, asignará los servidores de DonDominio para el servicio/alojamiento correspondiente.
    Sino, debe especificarse una lista de DNS (min. 2, máx. 7) separados por coma:
    ns1.dns.com,ns2.dns.com
    updateType = transferBlock
    transferBlock Requerido false (bool) Nuevo estado del bloqueo de transferencia
    updateType = block
    block Requerido false (bool) Nuevo estado del bloqueo
    updateType = whoisPrivacy
    whoisPrivacy Requerido false (bool) Nuevo estado del servicio de Whois Privacy
    updateType = viewWhois
    viewWhois Requerido false (bool) Nuevo estado de la visualización del Whois público
    updateType = renewalMode
    renewalMode Requerido Modo de renovación (Ver tabla)
    updateType = tag
    tag Requerido Etiquetas separadas por ,

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/update",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.7 Update NameServers ( domain/updatenameservers/ )

    Uso: Modificación de los servidores DNS de un dominio ( wrapper de domain/update [updateType=nameservers] )

    Petición:

    POST /domain/updatenameservers/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    nameservers Requerido Listado de servidores DNS
    Si el valor es default, asignará los servidores de DonDominio para el servicio/alojamiento correspondiente.
    Sino, debe especificarse una lista de DNS (min. 2, máx. 7) separados por coma:
    ns1.dns.com,ns2.dns.com

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/updatenameservers",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.8 Update Contacts ( domain/updatecontacts/ )

    Uso: Modificación de los contactos (Whois Data) de un dominio DNS de un dominio ( wrapper de domain/update [updateType=contact] )

    Petición:

    POST /domain/updatecontacts/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    ownerContact[Data] Opcional Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] Opcional Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] Opcional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/updatecontacts",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.9 GlueRecord Create ( domain/gluerecordcreate/ )

    Uso: Crear DNS asociado a un dominio ( crear gluerecord ).

    Petición:

    POST /domain/gluerecordcreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    name Requerido Nombre del servidor DNS asociado al dominio
    ipv4 Requerido IPv4
    ipv6 Opcional IPv6

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    gluerecords/name Nombre del servidor NS/GlueRecord
    gluerecords/ipv4 IPv4 del servidor NS/GlueRecord
    gluerecords/ipv6 IPv6 del servidor NS/GlueRecord

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/gluerecordcreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "gluerecords": [
                {
                    "name": "ns1.test-expample-domain.com",
                    "ipv4": "212.20.40.200",
                    "ipv6": "2e02:2670:3:0:21a:4aff:fe24:c49f"
                },
                {
                    "name": "ns2.test-expample-domain.com",
                    "ipv4": "213.20.40.201",
                }
            ]
    
        }
    }

    5.10 GlueRecord Update ( domain/gluerecordupdate/ )

    Uso: Actualizar DNS asociado a un dominio ( actualizar el gluerecord ).

    Petición:

    POST /domain/gluerecordupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    name Requerido Nombre del servidor DNS asociado al dominio
    ipv4 Requerido IPv4
    ipv6 Opcional IPv6

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    gluerecords/name Nombre del servidor NS/GlueRecord
    gluerecords/ipv4 IPv4 del servidor NS/GlueRecord
    gluerecords/ipv6 IPv6 del servidor NS/GlueRecord

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/gluerecordupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "gluerecords": [
                {
                    "name": "ns1.test-expample-domain.com",
                    "ipv4": "212.20.40.203",
                    "ipv6": "2e02:2670:3:0:21a:4aff:fe24:c49f"
                },
                {
                    "name": "ns2.test-expample-domain.com",
                    "ipv4": "213.20.40.201",
                }
            ]
    
        }
    }

    5.11 GlueRecord Delete ( domain/gluerecorddelete/ )

    Uso: Eliminar DNS asociado a un dominio ( borrar el gluerecord ).

    Petición:

    POST /domain/gluerecorddelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    name Requerido Nombre del servidor DNS asociado al dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    gluerecords/name Nombre del servidor NS/GlueRecord
    gluerecords/ipv4 IPv4 del servidor NS/GlueRecord
    gluerecords/ipv6 IPv6 del servidor NS/GlueRecord

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/gluerecorddelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "gluerecords": [
                {
                    "name": "ns2.test-expample-domain.com",
                    "ipv4": "213.20.40.201",
                }
            ]
    
        }
    }

    5.12 List ( domain/list/ )

    Uso: Realizar un listado/búsqueda de los dominios en tu cuenta

    Petición:

    POST /domain/list/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    domain Opcional Dominio exacto a filtrar
    word Opcional Cadena (substring) para filtrar en la lista de dominios
    tld Opcional Cadena para filtrar por el TLD del dominio
    renewable Opcional (Bool) Filtrar por la lista de dominios en periodo de renovación o no
    infoType Opcional Si se especifica, amplia la información del listado. Mirar el comando domain/getinfo para ver los campos de la respuesta
    status: Datos generales del dominio.
    contact: Datos de los contactos (whois data )
    nameservers: Servidores DNS del dominio
    service: Datos del servicio/alojamiento asociado
    gluerecords: Obtener los gluerecords asociados al dominio
    owner Opcional Identificador del contacto titular
    tag Opcional Filtro por etiqueta del dominio
    status Opcional Filtro por el estado del dominio. Ver tabla asociada
    ownerverification Opcional Filtro del estado de verificación de los datos del contacto titular

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    domains Lista de dominios obtenidos en la consulta
    domains/name Nombre del dominio
    domains/status Estado del dominio
    domains/tld TLD del dominio
    domains/tsExpir Fecha de expiración del dominio
    domains/domainID Identificador del dominio

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/list",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 10,
                "results": 10,
                "total": 27
            },
            "domains": [
                {
                    "name": "exampledomain1.com",
                    "status": "active",
                    "tld": "com",
                    "tsExpir": "2016-02-14",
                    "domainID": 1223421
                },
                {
                    "name": "exampledomain2.es",
                    "status": "active",
                    "tld": "es",
                    "tsExpir": "2016-02-28",
                    "domainID": 1123239
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    5.13 Get Info ( domain/getinfo/ )

    Uso: Obtener información de un dominio de tu cuenta.

    Petición:

    POST /domain/getinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    infoType Opcional status Tipo de información a obtener
    status: Datos generales del dominio.
    contact: Datos de los contactos (whois data )
    nameservers: Servidores DNS del dominio
    authcode: Obtiene el authcode
    service: Datos del servicio/alojamiento asociado
    gluerecords: Obtener los gluerecords asociados al dominio
    dnssec: Obtiene información sobre el DNSSEC

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    infoType = status
    tsCreate Fecha de creación
    renewable (bool) Indica si está en periodo de renovación
    renewalMode Modo de renovación del dominio ( Ver tabla )
    modifyBlock (bool) Indica si tiene las modificaciones bloqueadas
    transferBlock (bool) Indica si tiene la transferencia bloqueada
    (sólo en dominios que lo permiten)
    whoisPrivacy (bool) Indica si tiene activado el Whois Privacy
    (sólo en dominios que lo permiten)
    viewWhois (bool) Indica si tiene activado la visualización de datos en el Whois
    (sólo en dominios que lo permiten)
    authcodeCheck (bool) Flag que indica si se puede consultar el authcode con domain/getinfo/ [infoType=authcode]
    serviceAssociated (bool) Flag que indica si tiene un servicio/alojamiento asociado
    tag Etiqueta del dominio
    ownerverification Estado de la verficación de los datos del contacto titular (Ver tabla asociada)
    transferStatus Estado concreto de la transferencia en curso (Ver tabla asociada)
    infoType = contact
    contactOwner Ver sección Contact Response
    contactAdmin Ver sección Contact Response
    contactTech Ver sección Contact Response
    contactBilling Ver sección Contact Response
    infoType = nameservers
    defaultNS (bool) Indica si tiene los servidores DNS por defecto del servicio asociado
    nameservers Array con los nameservers, ver sección Nameservers Response
    infoType = authcode
    authcode AuthCode del dominio
    infoType = service
    service/name Nombre del servicio/alojamiento
    service/type Tipo de servicio/alojamiento
    service/productkey Clave del tipo de producto ( Ver Tabla )
    service/status Estado del servicio/alojamiento
    service/tsExpir Fecha de expiración del servicio/alojamiento
    infoType = gluerecords
    gluerecords/name Nombre del servidor NS/GlueRecord
    gluerecords/ipv4 IPv4 del servidor NS/GlueRecord
    gluerecords/ipv6 IPv6 del servidor NS/GlueRecord
    infoType = dnssec
    dnssec/active Indicador de si está activo el DNSSEC
    dnssec/entries Array con las entradas DNSSEC
    dnssec/entries/keytag KeyTag de la entrada DNSSEC
    dnssec/entries/algorithm Algoritmo de la entrada DNSSEC
    dnssec/entries/digesttype Tipo de Digest de la entrada DNSSEC
    dnssec/entires/digest Digest de la entrada DNSSEC

    Ejemplo de infoType = status

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 340598,
            "tsCreate": "2005-05-14",
            "renewable": true,
            "renewalMode": "autorenew",
            "modifyBlock": false,
            "transferBlock": true,
            "whoisPrivacy": true,
            "authcodeCheck": true,
            "serviceAssociated": false,
              "ownerverification": "verified"
        }
    }

    Ejemplo de infoType = contact

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 340598,
            "contactOwner": {
                "contactID": "JXD-2355464",
                "contactType": "organization",
                "firstName": "John",
                "lastName": "Ballack",
                "orgName": "Gotham S.L",
                "orgType": 612,
                "identNumber": "B336789224",
                "email": "john@test.com",
                "phone": "+34.90234232",
                "fax": "",
                "address": "Calle García, 25",
                "postalCode": "87500",
                "city": "Gotham City",
                "state": "Madrid",
                "country": "ES",
                "verificationstatus": "verified",
                "daaccepted": true
            },
            "contactAdmin": {
                    /* ... */
            },
            "contactTech": {
                    /* ... */
            },
            "contactBilling": {
                    /* ... */
            }
        }
    }

    Ejemplo de infoType = nameservers

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 340598,
            "defaultNS": false,
            "nameservers": [
                {
                    "order": 1,
                    "name": "ns1.example.com",
                    "ipv4": "13.19.246.4"
                },
                {
                    "order": 2,
                    "name": "ns2.example.com",
                    "ipv4": "13.19.246.5"
                }
            ]
        }
    }

    Ejemplo de infoType = authcode

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498,
            "authcode": "9523as&'asd1wAd"
        }
    }

    Ejemplo de infoType = service

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "service": {
                "name": "test-example-domain.com",
                "type": "Basic Hosting Service",
                    "productkey": "basic",
                "status": "Active",
                "tsExpir": "2015-12-10"
            }
        }
    }

    Ejemplo de infoType = gluerecords

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "gluerecords": [
                {
                    "name": "ns1.test-expample-domain.com",
                    "ipv4": "212.20.40.200",
                    "ipv6": "2e02:2670:3:0:21a:4aff:fe24:c49f"
                },
                {
                    "name": "ns2.test-expample-domain.com",
                    "ipv4": "213.20.40.201",
                }
            ]
    
        }
    }

    Ejemplo de infoType = dnssec

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "dnssec": {
                  "active": true,
                  "entries": [
                        {
                            "keytag": 257,
                            "algorithm": 13,
                            "digesttype": 3,
                            "digest": "mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ=="
                        }
                  ]
              }
    
        }
    }

    5.14 Get AuthCode ( /domain/getauthcode/ )

    Uso: Obtener el authode del dominio ( wrapper de /domain/getinfo [infoType=authcode])

    Petición:

    POST /domain/getauthcode/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    authcode AuthCode del dominio

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498,
            "authcode": "9523as&'asd1wAd"
        }
    }

    5.15 Get NameServers ( /domain/getnameservers/ )

    Uso: Obtener los servidores DNS del dominio ( wrapper de /domain/getinfo [infoType=nameservers])

    Petición:

    POST /domain/getnameservers/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    defaultNS Booleano que indica si tiene los servidores DNS por defecto del servicio asociado
    nameservers Array con los nameservers, ver sección Nameservers Response

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getnameservers",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498,
            "defaultNS": false,
            "nameservers": [
                {
                    "order": 1,
                    "name": "ns1.example.com",
                    "ipv4": "13.19.246.4"
                },
                {
                    "order": 2,
                    "name": "ns2.example.com",
                    "ipv4": "13.19.246.5"
                }
            ]
        }
    }

    5.16 Get GlueRecords ( /domain/getgluerecords/ )

    Uso: Obtener los servidores DNS asociados (GlueRecords) a un dominio ( wrapper de /domain/getinfo [infoType=gluerecords])

    POST /domain/getgluerecords/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    gluerecords/name Nombre del servidor NS/GlueRecord
    gluerecords/ipv4 IPv4 del servidor NS/GlueRecord
    gluerecords/ipv6 IPv6 del servidor NS/GlueRecord

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getgluerecords",
        "version": "1.0.20",
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "gluerecords": [
                {
                    "name": "ns1.test-expample-domain.com",
                    "ipv4": "212.20.40.200",
                    "ipv6": "2e02:2670:3:0:21a:4aff:fe24:c49f"
                },
                {
                    "name": "ns2.test-expample-domain.com",
                    "ipv4": "213.20.40.201",
                }
            ]
    
        }
    }

    5.17 Get DNSSEC ( /domain/getdnssec / )

    Uso: Obtener las entradas DNSSEC asociados a un dominio (wrapper de /domain/getinfo [infoType=dnssec])

    POST /domain/getdnssec/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    dnssec/active Indicador de si está activo el DNSSEC
    dnssec/entries Array con las entradas DNSSEC
    dnssec/entries/keytag KeyTag de la entrada DNSSEC
    dnssec/entries/algorithm Algoritmo de la entrada DNSSEC
    dnssec/entries/digesttype Tipo de Digest de la entrada DNSSEC
    dnssec/entries/digest Digest de la entrada DNSSEC
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getdnssec",
        "version": "1.0.20",
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "dnssec": {
                  "active": true,
                  "entries": [
                        {
                            "keytag": 257,
                            "algorithm": 13,
                            "digesttype": 3,
                            "digest": "mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ=="
                        }
                  ]
              }
    
        }
    }

    5.18 DNSSEC Create ( domain/dnsseccreate/ )

    Uso: Crear una entrada DNSSEC asociada a un dominio

    Petición:

    POST /domain/dnsseccreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    keytag Requerido Keytag de la entrada DNSSEC
    algorithm Requerido Algoritmo de la entrada DNSSEC
    digesttype Requerido Tipo de digest de la entrada DNSSEC
    digest Requerido Digest de la entrada DNSSEC

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    dnssec/active Indicador de si está activo el DNSSEC
    dnssec/entries Array con las entradas DNSSEC
    dnssec/entries/keytag KeyTag de la entrada DNSSEC
    dnssec/entries/algorithm Algoritmo de la entrada DNSSEC
    dnssec/entries/digesttype Tipo de Digest de la entrada DNSSEC
    dnssec/entries/digest Digest de la entrada DNSSEC

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/dnsseccreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "dnssec": {
                  "active": true,
                  "entries": [
                        {
                            "keytag": 257,
                            "algorithm": 13,
                            "digesttype": 3,
                            "digest": "mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ=="
                        }
                  ]
        }
    }

    5.19 DNSSEC Delete ( domain/dnssecdelete/ )

    Uso: Eliminar una entrada DNSSEC asociada a un dominio.

    Petición:

    POST /domain/dnssecdelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    keytag Requerido Keytag de la entrada DNSSEC
    algorithm Requerido Algoritmo de la entrada DNSSEC
    digesttype Requerido Tipo de digest de la entrada DNSSEC
    digest Requerido Digest de la entrada DNSSEC

    Descripción de los campos de respuesta:

    Campo Descripción
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    dnssec/active Indicador de si está activo el DNSSEC
    dnssec/entries Array con las entradas DNSSEC
    dnssec/entries/keytag KeyTag de la entrada DNSSEC
    dnssec/entries/algorithm Algoritmo de la entrada DNSSEC
    dnssec/entries/digesttype Tipo de Digest de la entrada DNSSEC
    dnssec/entires/digest Digest de la entrada DNSSEC

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/dnssecdelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "test-expample-domain.com",
            "status": "active",
            "tld": "com",
            "tsExpir": "2016-02-14",
            "domainID": 1223423,
            "dnssec": {
                  "active": true,
                  "entries": [
                        {
                            "keytag": 257,
                            "algorithm": 13,
                            "digesttype": 3,
                            "digest": "mdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ=="
                        }
                  ]
        }
    }

    5.20 Renew ( domain/renew/ )

    Uso: Aplicar la renovación de un dominio

    Petición:

    POST /domain/renew/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio
    curExpDate Requerido Fecha actual de expiración en formato YYYYMMDD o YYYY-MM-DD
    period Opcional Min years (normalmente 1 año) Número de años de renovación del dominios (por defecto el número mínimo de años)

    Descripción de los campos de respuesta:

    Campo Descripción
    billing/total Coste total de la operación
    billing/currency Moneda de la operacion
    domains/name Nombre del dominio
    domains/status Estado del dominio
    domains/tld TLD del dominio
    domains/domainID Identificador del dominio
    domains/tsExpir Fecha de expiración del dominio
    domains/renewPeriod Periodo de renovación
    domains/inPromo (bool) Indica si el TLD dispone de una promo
    Sólo cuando es true

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/renew",
        "version": "1.0.20",
        "responseData": {
            "billing": {
                "total": 53.25,
                "currency": "EUR"
            },
            "domains": [
                {
                    "name": "example-domain.tel",
                    "status": "renewed",
                    "tld": "tel",
                    "domainID": 153508,
                    "tsExpir": "2015-05-17",
                    "renewPeriod": "4"
                }
            ]
        }
    }
    

    5.21 Whois ( domain/whois/ )

    Uso: Realizar una consulta al Whois público del dominio

    Limitaciones: Por defecto, sólo se pueden hacer consultas de dominios de la lista de dominios en la cuenta de cliente.

    Petición:

    POST /domain/whois/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido Dominio en formato punycode

    Descripción de los campos de respuesta:

    Campo Descripción
    domain Nombre de dominio
    whoisData Texto con el Whois público

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/whois",
        "version": "1.0.20",
        "responseData": {
            "domain": "example1.com",
            "whoisData": "Domain Name: EXAMPLE1.COM\nRegistry Domain ID... whois data..."
        }
    }

    5.22 Resend Verification Mail ( domain/resendverificationmail )

    Uso: Reenviar el correo de verifificación del contacto titular del dominio

    Petición:

    POST /domain/resendverificationmail/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/resendverificationmail",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.23 Resend FOA Mail ( domain/resendfoamail )

    Uso: Reenviar el email de autorización del FOA al contacto titular

    Petición:

    POST /domain/resendfoamail/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/resendfoamail",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.24 Reset FOA ( domain/resetfoa )

    Uso: Reiniciar el proceso de autorización del dominio ( sólo cuando está en proceso de transferencia )

    Petición:

    POST /domain/resetfoa/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/resetfoa",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-domain.tv",
            "status": "transfer-init",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.25 Get History ( domain/gethistory/ )

    Uso: Petición del historial del dominio

    Petición:

    POST /domain/gethistory/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    domain Requerido
    (a menos que el campo domainID esté especificado)
    Nombre del dominio
    domainID Requerido
    (a menos que el campo domain esté especificado)
    Identificador del dominio

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    name Nombre del dominio
    status Estado del dominio
    tld TLD del dominio
    tsExpir Fecha de expiración del dominio
    domainID Identificador del dominio
    history/ts History TimeStamp
    history/ip IP Address
    history/title Título
    history/message Mensaje

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/gethistory",
        "version": "1.0.20",
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "queryInfo": {
                "page": 1,
                "pageLength": 1,
                "results": 1,
                "total": 82
            },
            "history": [
                {
                    "ts": "2018-05-29 12:34:07",
                    "ip": "1.1.1.1",
                    "user": "malcomX",
                    "title": "Whois Privacy status",
                    "message": "The Whois privacy service has been activated."
                }
            ]
    
        }
    }

    5.26 List Deleted ( domain/listdeleted/ )

    Uso: Lista de dominios borrados

    Petición:

    POST /domain/listdeleted/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    domains Lista de dominios obtenidos en la consulta
    domains/name Nombre del dominio
    domains/tld TLD del dominio
    domains/tsDeleted Fecha de borrado del dominio
    domains/domainID Identificador del dominio
    domains/info Información
    
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/listdeleted",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 2,
                "results": 2,
                "total": 5
            },
            "domains": [
                {
                    "name": "domaindeleted.sexy",
                    "tld": "sexy",
                    "tsDeleted": "2018-11-25",
                    "info": "Domain expired"
                },
                {
                    "name": "dondominio.test",
                    "tld": "si",
                    "tsDeleted": "2015-11-26",
                    "info": "Domain expired"
                }
            ]
        }
    }

    5.27 Contact Response

    Descripción de los campos de respuesta:

    Campo Descripción
    contactID Identificador del contacto
    contactType Tipo de contacto:
    individual: Persona física
    organization: Organización / Empresa
    firstName Nombre del contacto
    lastName Apellidos del contacto
    orgName Nombre de la organización / empresa
    orgType En el caso de country = ES, tipo de organización (Ver tabla)
    identNumber VAT number, passport, idenficación de la persona u organización
    email Correo electrónico
    phone Teléfono en formato (+DD.DDDDDDDD)
    fax Número de fax en formato (+DD.DDDDDDDD)
    address Dirección
    postalCode Código postal
    city Ciudad
    state Estado/Província
    country Código de país (Ver tabla)
    verificationstatus Estado de la verificación de los datos del contacto (Ver tabla asociada)
    daaccepted Flag que indica si el contacto tiene el Designated Agent (DA) aceptado o no
    esNicHandle NIC Handle de un dominio .ES

    Ejemplo de respuesta:

    {
        /* ... */
        "contact": {
            "contactID": "XXX-12323428",
            "contactType": "individual",
            "firstName": "James",
            "lastName": "Smith",
            "orgName": "",
            "orgType": "",
            "identNumber": "556465463E",
            "email": "james.smith@example.es",
            "phone": "+34.626891524",
            "fax": "",
            "address": "Vía grande, 25",
            "postalCode": "17509",
            "city": "Mycity",
            "state": "My Province",
            "country": "ES",
            "verificationstatus": "verified",
            "daaccepted": true,
            "esNicHandle": "XX8892-ESNIC-F4"
        }
    }

    5.28 Nameserver Reponse

    Descripción de los campos de respuesta:

    Campo Descripción
    order Número del nameserver en un dominio
    name Nombre del nameservers
    ipv4 Dirección IPv4

    Ejemplo de respuesta:

    {
        /* ... */
          "nameservers": [
                {
                     "name": "ns3.dondominio.com",
                     "order": 1,
                     "ipv4": "37.152.88.12"
                },
                {
                     "name": "ns2.dondominio.com",
                     "order": 2,
                     "ipv4": "178.33.146.32"
                }
          ]
    }

    5.29 Tablas de Dominio asociadas

    5.29.1 Domain Status

    Status Definición
    register-init Registro no iniciado
    register-pending Registro en proceso
    register-cancel Registro cancelado
    transfer-init Transferencia no iniciada
    transfer-pending Transferencia en cola
    transfer-cancel Transferencia cancelada
    inactive Inactivo
    active Activo
    renewed Renovación en proceso
    expired-renewgrace Expirado ( Renew Grace Period )
    expired-redemption Expirado ( Redemption Period )
    expired-pendingdelete Expirado ( Pending Delete Period )

    5.29.2 Transfer Status

    Status Definición
    init Transferencia no iniciada
    queued Pendiente de aprobación del registry
    set-auth Authcode comunicado
    pending-auth Pendiente de authcode
    pending-foa Pendiente de foa
    pending-tag Pendiente de tag (.UK)
    pending-registry Pendiente de datos en el registry
    cancelled Cancelada
    completed Completada

    5.29.3 Modos de renovación

    Keyword Definición
    autorenew Autorenovación automática
    manual Renovación manual
    letexpire Dejar expirar

    5.29.4 Domain Owner Contact Verification Status

    Status Definición
    verified Verificado
    notapplicable No aplica o no es necesaria la verificación
    inprocess En proceso de verificación
    failed Verificación fallida o expirada

    5.29.5 Contact Verification Status

    Status Definición
    verified Verificado
    notapplicable No aplica o no es necesaria la verificación
    inprocess En proceso de verificación
    failed Verificación fallida o expirada

    6 Modulo: Contact

    El módulo contact permite el acceso a diferentes opciones sobre los contactos de los dominios (listar, buscar, obtener información detallada, etc..).

    Acciones disponibles:

    Acción Credenciales Descripción
    /contact/create/ Required Crea un contacto
    /contact/list/ Requeridas Buscar/filtrar/listar los contactos de la cuenta
    /contact/getinfo/ Requeridas Obtener información detallada de un contacto
    /contact/resendverificationmail/ Requeridas Reenviar el email de verificación de los datos del contacto

    6.1 Create ( contact/create/ )

    Use: Crea un contacto en la cuenta.

    Petición:

    POST /contact/create/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    Type Requerido Tipo de contacto: individual o organization
    FirstName Requerido Nombre del contacto
    LastName Requerido Apellidos del contacto
    OrgName Requerido
    si adminContactType = organization
    Nombre de la empresa
    OrgType Requerido
    si adminContactType = organization
    y adminContactCountry = ES
    Tipo de organización española (Ver tabla)
    IdentNumber Requerido Número de identificación fiscal, VAT Number, etc...
    Email Requerido Correo electrónico del contacto
    Phone Requerido Número de teléfono del contacto en formato +DD.DDDDDDDD
    Fax Opcional Número de teléfono del contacto en formato +DD.DDDDDDDD
    Address Requerido Dirección del contacto
    PostalCode Requerido Código Postal del contacto
    City Requerido Estado/Provincia del contacto
    State Requerido State/Province
    Country Requerido (String 2 letras) Código de país (Ver tabla)

    Descripción de los campos de respuesta:

    Campo Descripción
    contactID Identificador del contacto
    contactType Tipo de contacto:
    individual: Persona física
    organization: Organización / Empresa
    firstName Nombre del contacto
    lastName Apellidos del contacto
    orgName Nombre de la organización / empresa
    orgType En el caso de country = ES, tipo de organización (Ver tabla)
    identNumber VAT number, passport, idenficación de la persona u organización
    email Correo electrónico
    phone Teléfono en formato (+DD.DDDDDDDD)
    fax Número de fax en formato (+DD.DDDDDDDD)
    address Dirección
    postalCode Código postal
    city Ciudad
    state Estado/Província
    country Código de país (Ver tabla)
    verificationstatus Estado de la verificación de los datos del contacto (Ver tabla de contact verification status)
    daaccepted Flag que indica si el contacto tiene el Designated Agent (DA) aceptado o no

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "contact\/create",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "contactID": "WF-420197",
            "contactType": "individual",
            "firstName": "Will",
            "lastName": "Ford",
            "orgName": "",
            "orgType": "",
            "identNumber": "AAAAAA",
            "email": "testtest@test.com",
            "phone": "+1.123456789",
            "fax": "",
            "address": "Street 1",
            "postalCode": "12345",
            "city": "Gotham City",
            "state": "Gotham",
            "country": "US",
            "verificationstatus": "notapplicable",
            "daaccepted": false
        }
    }

    6.2 List ( contact/list/ )

    Uso: Realizar un listado/búsqueda de los contactos en tu cuenta

    Petición:

    POST /contact/list/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    name Opcional Cadena a buscar en el nombre/organización
    email Opcional Filtro por correo electrónico
    country Opcional Filtro por código de país
    identNumber Opcional Filtro por identificacion
    verificationstatus Opcional Filtro del estado de la verificación
    daaccepted Opcional (Bool) Filtrar por los contactos que tienen el Designated Agent (DA) aceptado o no

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    contacts/contactID Identificador del contacto
    contacts/contactType Tipo de contacto:
    individual: Persona física
    organization: Organización / Empresa
    contacts/contactName Nombre principal del contacto ( Organization Name o Individual Name)
    contacts/email Correo electrónico
    contacts/country Código de pais (Ver tabla)
    contacts/verificationstatus Estado de la verificación de los datos del contacto (Ver tabla asociada)
    contacts/daaccepted Flag que indica si el contacto tiene el Designated Agent (DA) aceptado o no
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "contact\/list",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 14,
                "total": 14
            },
            "contacts": [
                {
                    "contactID": "JS-199180",
                    "contactType": "individual",
                    "contactName": "John Smith",
                    "identNumber": "4-8-15-16-23-42",
                    "email": "johnsmith@example.xv",
                    "country": "US",
                    "verificationstatus": "verified",
                    "daaccepted": true
                },
                {
                    "contactID": "WF-420197",
                    "contactType": "individual",
                    "contactName": "Will Ford",
                    "identNumber": "AAAAAA",
                    "email": "testtest@test.com",
                    "country": "US",
                    "verificationstatus": "notapplicable",
                    "daaccepted": false
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    6.3 Get Info ( contact/getinfo/ )

    Petición:

    POST /contact/getinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    contactID Requerido Identificador del contacto
    infoType Opcional data Tipo de información a obtener
    data: Datos del contacto

    Descripción de los campos de respuesta:

    Campo Descripción
    infoType = data
    contactXXX Ver sección Contact Response

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "contact\/getinfo",
        "version": "1.0.20",
        "responseData": {
                "contactID": "JXD-2355464",
                "contactType": "organization",
                "firstName": "John",
                "lastName": "Ballack",
                "orgName": "Gotham S.L",
                "orgType": 612,
                "identNumber": "B336789224",
                "email": "john@test.com",
                "phone": "+34.90234232",
                "fax": "",
                "address": "Calle García, 25",
                "postalCode": "87500",
                "city": "Gotham City",
                "state": "Madrid",
                "country": "ES",
                "verificationstatus": "verified",
                "daaccepted": true
        }
    }

    6.4 Resend Verification Mail ( contact/resendverificationmail )

    Uso: Reenviar el correo de verificación de los datos del contacto

    Petición:

    POST /contact/resendverificationmail/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    contactID Requerido Identificador del contacto

    Descripción de los campos de respuesta:

    Campo Descripción
    contactID Identificador del contacto
    contactType Tipo de contacto:
    individual: Persona física
    organization: Organización / Empresa
    contactName Nombre principal del contacto ( Organization Name o Individual Name)
    email Correo electrónico
    country Código de pais (Ver tabla)
    verificationstatus Estado de la verificación de los datos del contacto (Ver tabla asociada)
    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "contact\/resendverificationmail",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
                 "contactID": "CTS-378084",
                 "contactType": "organization",
                 "contactName": "Clark Tech S.L",
                 "identNumber": "XSS2342342-3",
                 "email": "tech-email@example.com",
                 "country": "ES",
                 "verificationstatus": "verified"
        }
    }

    7 Modulo: Service

    El módulo service permite el acceso a las diferentes opciones sobre los alojamientos compartidos y servicios de correo.

    Acciones disponibles:

    Acción Credenciales Descripción
    /service/list/ Requeridas Buscar/Filtrar/Listar los servicios asociados
    /service/getinfo/ Requeridas Obtener datos de un servicio/alojamiento
    /service/create/ Requeridas Crear/asociar un nuevo servicio/alojamiento
    /service/renew/ Requeridas Renovar un servicio/alojamiento
    /service/upgrade/ Requeridas Ampliar a un plan de servicio/alojamiento superior
    /service/update/ Requeridas Cambiar datos globales del servicio de alojamiento
    /service/parkinggetinfo/ Requeridas Obtener información sobre el sistema de Parking
    /service/parkingupdate/ Requeridas Actualizar el estado del sistema de Parking
    /service/webconstructorlogin/ Requeridas Obtener una URL para realizar el login al constructor de webs
    /service/ftplist/ Requeridas Buscar/Filtrar/Listar las cuentas FTP asociados a un servicio/alojamiento
    /service/ftpgetinfo/ Requeridas Obtener información de una cuenta FTP
    /service/ftpcreate/ Requeridas Crear una cuenta FTP
    /service/ftpupdate/ Requeridas Modificar una cuenta FTP
    /service/ftpdelete/ Requeridas Borrar una cuenta FTP
    /service/ddbblist/ Requeridas Buscar/Filtrar/Listar las cuentas bases de datos asociadas a un servicio/alojamiento
    /service/ddbbgetinfo/ Requeridas Obtener información de una Base de Datos
    /service/ddbbcreate/ Requeridas Crear de una Base de Datos
    /service/ddbbupdate/ Requeridas Modificar de una Base de Datos
    /service/ddbbdelete/ Requeridas Borrar una Base de Datos
    /service/subdomainlist/ Requeridas Buscar/Filtrar/Listar los subdominios asociados a un servicio/alojamiento
    /service/subdomaingetinfo/ Requeridas Obtener información de un subdominio
    /service/subdomaincreate/ Requeridas Crear un subdominio
    /service/subdomainupdate/ Requeridas Modificar de un subdominio
    /service/subdomaindelete/ Requeridas Borrar un subdominio
    /service/redirectlist/ Requeridas Buscar/Filtrar/Listar las redirecciones asociadas a un servicio/alojamiento
    /service/redirectgetinfo/ Requeridas Obtener información de un redirección
    /service/redirectcreate/ Requeridas Crear un redirección
    /service/redirectupdate/ Requeridas Modificar de una redirección
    /service/redirectdelete/ Requeridas Borrar una redirección
    /service/maillist/ Requeridas Buscar/Filtrar/Listar las cuentas de correo asociadas a un servicio/alojamiento
    /service/mailgetinfo/ Requeridas Obtener información de una cuenta de correo
    /service/mailcreate/ Requeridas Crear una cuenta de correo
    /service/mailupdate/ Requeridas Modificar de una cuenta de correo
    /service/maildelete/ Requeridas Borrar una cuenta de correo
    /service/mailaliaslist/ Requeridas Buscar/Filtrar/Listar los alias de correo asociados a un servicio/alojamiento
    /service/mailaliasgetinfo/ Requeridas Obtener información de un alias de correo
    /service/mailaliascreate/ Requeridas Crear un alias de correo
    /service/mailaliasupdate/ Requeridas Modificar de un alias de correo
    /service/mailaliasdelete/ Requeridas Borrar un alias de correo
    /service/dnslist/ Requeridas Buscar/Filtrar/Listar las zonas DNS asociados a un servicio/alojamiento
    /service/dnsgetinfo/ Requeridas Obtener información de una zona DNS
    /service/dnscreate/ Requeridas Crear una zona DNS nueva
    /service/dnsupdate/ Requeridas Modificar una zona DNS
    /service/dnsdelete/ Requeridas Borrar una zona DNS
    /service/dnsrestore/ Requeridas Restaura a las valores por defecto todas las zonas DNS
    /service/dnssetzone/ Requeridas Setea toda la zona DNS
    /service/dnsdeleteall/ Requeridas Borra todas las zonas DNS

    7.1 List ( service/list/ )

    Uso: Realizar un listado/búsqueda de los servicios y alojamientos de tu cuenta

    Petición:

    POST /service/list/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    name Opcional Nombre del servicio/alojamiento exacto a filtrar
    word Opcional Cadena (substring) para filtrar en la lista de servicios asociados
    tld Opcional Cadena para filtrar por el TLD del servicio
    renewable Opcional (Bool) Filtrar por la lista de servicios en periodo de renovación o no
    status Opcional Estado del servicio/alojamiento a filtrar

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    services Lista de servicios/alojamientos obtenidos en la consulta
    services/name Nombre del servicio/alojamiento
    services/status Estado del servicio ( Ver tabla )
    services/type Tipo de servicio/alojamiento
    services/productkey Clave del tipo de servicio/alojamiento
    services/tsExpir Fecha de expiración del alojamiento

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/list",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 5,
                "results": 5,
                "total": 1
            },
            "services": [
                {
                    "name": "example-test.net",
                    "type": "Basic Hosting Service",
                    "productkey": "basic",
                    "status": "active",
                    "tsExpir": "2025-06-19"
                },
                {
                    "name": "example-123test.cat",
                    "type": "Mini Hosting Service",
                    "productkey": "mini",
                    "status": "active",
                    "tsExpir": "2018-10-09"
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.2 Get Info ( service/getinfo/ )

    Uso: Obtener información de un servicio/alojamiento

    Petición:

    POST /service/getinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio
    infoType Opcional status Tipo de información a obtener
    status: Datos generales del servicio/alojamiento
    resources: Información sobre los recursos disponibles del alojamiento
    serverinfo: Datos de servidores y paths asociados al servicio
    php: Información sobre la versión de PHP
    logerror: Lineas del log de errores del hosting

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del servicio/alojamiento
    status Estado del servicio ( Ver tabla )
    type Tipo de servicio/alojamiento
    tsExpir Fecha de expiración del alojamiento
    infoType = status
    tsCreate Fecha de creación del servicio
    renewable (bool) Indica si está en periodo de renovación
    renewalMode Modo de renovación ( Ver tabla )
    infoType = resources
    resources/ftpusage/value Valor del uso de FTP
    resources/ftpusage/max Valor máximo de uso del ftp
    resources/ftpusage/unit Unidad de uso de FTP (bytes)
    resources/ftpfiles/value Número de archivos existentes
    resources/ftpfiles/max Número máximo de archivos permitidos
    resources/ftpfiles/unit Unidad de archivos existentes (files)
    resources/webtraffic/value Valor del consumo de tráfico del mes actual
    resources/webtraffic/max Valor máximo de uso del tráfico web
    resources/webtraffic/unit Unidad (bytes)
    resources/ftp/value Número de cuentas FTP
    resources/ftp/max Número de máximo de cuentas FTP
    resources/ftp/unit -
    resources/ddbb/value Número de bases de datos
    resources/ddbb/max Número máximo de bases de datos
    resources/ddbb/unit -
    resources/ddbbusage/value Espacio utilizado por las Bases de datos
    resources/ddbbusage/max Valor máximo de espacio de disco utilizado por las bases de datos
    resources/ddbbusage/unit Unidad (bytes)
    resources/subdomain/value Número de subdominios
    resources/subdomain/max Número máximo de subdominios
    resources/subdomain/unit -
    resources/email/value Número de cuentas de correo
    resources/email/max Número máximo de cuentas de correo
    resources/email/unit -
    resources/emailalias/value Número de cuentas de alias de correo
    resources/emailalias/max Número máximo de cuentas de alias de correo
    resources/emailalias/unit -
    infoType = php
    php/enabled (bool) Indica si PHP está activado en el servicio
    php/version Versión de PHP actual
    php/name Texto indicando la versión de PHP actual
    php/available Listado de versiones de PHP disponibles
    infoType = serverinfo
    serverinfo/ftpServer Nombre del servidor FTP
    serverinfo/ftpAbsolutePath Path absoluto en el sevidor FTP
    serverinfo/ftpWebServer Servidor Web FTP
    serverinfo/smtpServer Servidor SMTP ( Correo saliente )
    serverinfo/pop3Server Servidor POP3
    serverinfo/imapServer Servidor IMAP
    serverinfo/webmail Servicio de WebMail
    serverinfo/ddbbServer Servidor de Base de datos
    serverinfo/PHPMyAdmin Instalación de PHPMyAdmin para administrar la Base de Datos
    infoType = logerror
    logError Lineas del log de errores del hosting

    Ejemplo de infoType= status

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-test01.com",
            "type": "Basic Hosting Service",
            "status": "active",
            "tsExpir": "2015-12-10",
            "tsCreate": "2014-12-10"
            "renewable": false,
        }
    }

    Ejemplo de infoType = resources

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-test01.com",
            "type": "Basic Hosting Service",
            "status": "active",
            "tsExpir": "2015-12-10",
            "resources": {
                "ftpusage": {
                    "value": 11534336,
                    "max": 1038336000,
                    "unit": "bytes"
                },
                "ftpfiles": {
                    "value": 4574,
                    "max": 100101,
                    "unit": "files"
                },
                "webtraffic": {
                    "value": 0,
                    "max": 12759072768,
                    "unit": "bytes"
                },
                "ftp": {
                    "value": 1,
                    "max": 100,
                    "unit": ""
                },
                "ddbb": {
                    "value": 1,
                    "max": 10,
                    "unit": ""
                },
                "ddbbusage": {
                    "value": 0,
                    "max": 104857600,
                    "unit": "bytes"
                },
                "subdomain": {
                    "value": 2,
                    "max": 100,
                    "unit": ""
                },
                "email": {
                    "value": 1,
                    "max": 100,
                    "unit": ""
                },
                "emailalias": {
                    "value": 0,
                    "max": 100,
                    "unit": ""
                }
            }
        }
    }

    Ejemplo de infoType = php

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example.com",
            "type": "Advanced Hosting Service",
            "productkey": "advanced",
            "status": "renewed",
            "tsExpir": "2022-12-10",
            "php": {
                "enabled": true,
                "version": "default",
                "name": "Default version (PHP 7.4)",
                "available": [
                    "default",
                    "8.0",
                    "7.4",
                    "7.3",
                    "7.2",
                    "7.1",
                    "7.0"
                ]
            }
        }
    }

    Ejemplo de infoType = serverinfo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example-test01.com",
            "type": "Basic Hosting Service",
            "status": "active",
            "tsExpir": "2015-12-10",
            "serverinfo": {
                "ftpServer": "ftp.example-test01.com",
                "ftpAbsolutePath": "\/var\/www\/example-test01.com\/",
                "ftpWebServer": "https:\/\/webftp.dondominio.com\/\/?ftpserver=example-test01.com",
                "smtpServer": "smtp.example-test01.com",
                "pop3Server": "pop3.example-test01.com",
                "imapServer": "imap.example-test01.com",
                "webmail": "http:\/\/webmail.example-test01.com\/",
                "ddbbServer": "bbdd.example-test01.com",
                "PHPMyAdmin": "https:\/\/adminbbdd.dondominio.com\/?server=2341"
            }
        }
    }

    Ejemplo de infoType = logerror

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "name": "example.com",
            "type": "Advanced Hosting Service",
            "productkey": "advanced",
            "status": "renewed",
            "tsExpir": "2022-12-10",
            "logError": "[Tue Jun 29 15:50:00.160542 2021] [autoindex:error] [pid 25304] [client 66.249.75.99:35422] AH01276: Cannot serve directory \/var\/www\/example.com\/public\/: No matching DirectoryIndex (index.html,index.cgi,index.pl,index.php,index.xhtml,index.htm) found, and server-generated directory index forbidden by Options directive\n[Tue Jun 29 15:29:47.009317 2021] [autoindex:error] [pid 25239] [client 167.71.170.4:60098] AH01276: Cannot serve directory \/var\/www\/example.com\/public\/: No matching DirectoryIndex (index.html,index.cgi,index.pl,index.php,index.xhtml,index.htm) found, and server-generated directory index forbidden by Options directive\n [Tue Jun 29 14:13:27.001780 2021] [-:error] [pid 25239] [client 3.141.12.245:33556] [client 3.141.12.245] ModSecurity: Access denied with code 403 (phase 2). Pattern match \"python-requests\/\" at REQUEST_HEADERS:User-Agent. [file \"\/etc\/modsecurity\/atomicorp-rules\/20_asl_useragents.conf\"] [line \"218\"] [id \"332039\"] [rev \"4\"] [msg \"Atomicorp.com WAF Rules: Suspicious Unusual User Agent (python-requests).  Disable this rule if you use python-requests\/. \"] [severity \"CRITICAL\"] [hostname \"example.com\"] [uri \"\/\"] [unique_id \"YNsOZrGlwUcMzwtNS8vwywAAAOQ\"]\n[Tue Jun 29 14:13:26.507079 2021] [-:error] [pid 25239] [client 3.141.12.245:43320] [client 3.141.12.245] ModSecurity: Access denied with code 403 (phase 2). Pattern match \"python-requests\/\" at REQUEST_HEADERS:User-Agent. [file \"\/etc\/modsecurity\/atomicorp-rules\/20_asl_useragents.conf\"] [line \"218\"] [id \"332039\"] [rev \"4\"] [msg \"Atomicorp.com WAF Rules: Suspicious Unusual User Agent (python-requests).  Disable this rule if you use python-requests\/. \"] [severity \"CRITICAL\"] [hostname \"www.example.com\"] [uri \"\/\"] [unique_id \"YNsOZrGlwUcMzwtNS8vwygAAAOY\"]\n[Tue Jun 29 12:50:44.666937 2021] [autoindex:error] [pid 25167] [client 52.13.105.193:35674] AH01276: Cannot serve directory \/var\/www\/example.com\/public\/: No matching DirectoryIndex (index.html,index.cgi,index.pl,index.php,index.xhtml,index.htm) found, and server-generated directory index forbidden by Options directive\n[Tue Jun 29 11:49:00.301716 2021] [autoindex:error] [pid 25304] [client 54.202.141.28:4167] AH01276: Cannot serve directory \/var\/www\/example.com\/public\/: No matching DirectoryIndex (index.html,index.cgi,index.pl,index.php,index.xhtml,index.htm) found, and server-generated directory index forbidden by Options directive\n[Tue Jun 29 11:47:53.370047 2021] [autoindex:error] [pid 25284] [client 34.214.184.5:63343] AH01276: Cannot serve directory \/var\/www\/example.com\/public\/: No matching DirectoryIndex (index.html,index.cgi,index.pl,index.php,index.xhtml,index.htm) found, and server-generated directory index forbidden by Options directive\n[Tue Jun 29 08:46:07.219298 2021] [proxy_fcgi:error] [pid 25239] [client 118.70.52.135:48470] AH01071: Got error 'PHP message: PHP Warning:  get_comment(): Argument #1 ($comment) must be passed by reference, value given in \/hosting\/www\/example.com\/blog\/wp-includes\/class-wp-comment-query.php on line 484'\n[Tue Jun 29 07:54:01.638034 2021] [-:error] [pid 25239] [client 5.188.210.4:63137] [client 5.188.210.4] ModSecurity: Access denied with code 403 (phase 2). Pattern match \"(?:getfoldersandfiles|fileupload)\" at ARGS:Command. [file \"\/etc\/modsecurity\/atomicorp-rules\/99_asl_jitp.conf\"] [line \"1015\"] [id \"388000\"] [rev \"1\"] [msg \"Atomicorp.com WAF Rules - Virtual Just In Time Patch: Possible Attempt to Access vulnerable FCKeditor file upload connector (Disable if you have configured this connector to require authentication)\"] [data \"\/editor\/filemanager\/connectors\/php\/connector.php\"] [severity \"CRITICAL\"] [hostname \"www.example.com\"] [uri \"\/admin\/editor\/editor\/filemanager\/connectors\/php\/connector.php\"] [unique_id \"YNq1ebGlwUcMzwtNS8vu@QAAAOI\"]\n [Tue Jun 29 01:37:46.075771 2021] [-:error] [pid 25284] [client 52.14.240.234:59064] [client 52.14.240.234] ModSecurity: Access denied with code 403 (phase 2). Pattern match \"python-requests\/\" at REQUEST_HEADERS:User-Agent. [file \"\/etc\/modsecurity\/atomicorp-rules\/20_asl_useragents.conf\"] [line \"218\"] [id \"332039\"] [rev \"4\"] [msg \"Atomicorp.com WAF Rules: Suspicious Unusual User Agent (python-requests).  Disable this rule if you use python-requests\/. \"] [severity \"CRITICAL\"] [hostname \"example.com\"] [uri \"\/\"] [unique_id \"YNpdSkLrDsBNjnn2uRmQmwAAAAo\"]\n"
        }
    }

    7.3 Create ( service/create/ )

    Uso: Crear/asociar un nuevo servicio de alojamiento

    Recomendaciones: Algunas operaciones conllevan un gasto de saldo, se puede comprobar que se tiene saldo disponible mediante una petición de account/info.

    Petición:

    POST /service/create/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio
    productkey Requerido Clave de producto ( Ver tabla )
    period Opcional 1 Número de años de contratación

    Descripción de los campos de respuesta:

    Campo Descripción
    billing/total Coste total de la operación
    billing/currency Moneda de la operacion
    services/name Nombre del servicio/alojamiento
    services/status Estado del servicio ( Ver tabla )
    services/type Tipo de servicio/alojamiento
    services/productkey Clave del tipo de servicio/alojamiento
    services/tsExpir Fecha de expiración del alojamiento

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/create",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "billing": {
                "total": 12.04,
                "currency": "EUR"
            },
            "services": [
                {
                    "name": "example-test.net",
                    "type": "Basic Hosting Service",
                         "productkey": "basic",
                    "status": "active",
                    "tsExpir": "2025-06-19"
                }
              ]
        }
    }

    7.4 Renew ( service/renew/ )

    Uso: Renovar un servicio de alojamiento

    Recomendaciones: Algunas operaciones conllevan un gasto de saldo, se puede comprobar que se tiene saldo disponible mediante una petición de account/info.

    Petición:

    POST /service/renew/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio
    period Opcional 1 Número de años de contratación

    Descripción de los campos de respuesta:

    Campo Descripción
    billing/total Coste total de la operación
    billing/currency Moneda de la operacion
    services/name Nombre del servicio/alojamiento
    services/status Estado del servicio ( Ver tabla )
    services/type Tipo de servicio/alojamiento
    services/productkey Clave del tipo de servicio/alojamiento
    services/tsExpir Fecha de expiración del alojamiento

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/renew",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "billing": {
                "total": 12.04,
                "currency": "EUR"
            },
            "services": [
                {
                    "name": "example-test.net",
                    "type": "Basic Hosting Service",
                         "productkey": "basic",
                    "status": "renewed",
                    "tsExpir": "2025-06-19"
                }
              ]
        }
    }

    7.5 Upgrade ( service/upgrade/ )

    Uso: Ampliar a un plan de servicio/alojamiento superior

    Recomendaciones: Algunas operaciones conllevan un gasto de saldo, se puede comprobar que se tiene saldo disponible mediante una petición de account/info.

    Petición:

    POST /service/upgrade/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio
    productkey Requerido Clave de producto ( Ver tabla )

    Descripción de los campos de respuesta:

    Campo Descripción
    billing/total Coste total de la operación
    billing/currency Moneda de la operacion
    services/name Nombre del servicio/alojamiento
    services/status Estado del servicio ( Ver tabla )
    services/type Tipo de servicio/alojamiento
    services/productkey Clave del tipo de servicio/alojamiento
    services/tsExpir Fecha de expiración del alojamiento

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/upgrade",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "billing": {
                "total": 12.04,
                "currency": "EUR"
            },
            "services": [
                {
                    "name": "example-test.net",
                    "type": "Basic Hosting Service",
                         "productkey": "basic",
                    "status": "active",
                    "tsExpir": "2025-06-19"
                }
              ]
        }
    }

    7.6 Update ( service/update/ )

    Uso: Modificar parámetros globales del servicio de alojamiento

    Petición:

    POST /service/update/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio
    updateType Requerido Tipo de información a actualizar
    renewalMode: Cambio en el modo de renovación
    phpversion: Cambia la versión de PHP
    updateType = renewalMode
    renewalMode Requerido Modo de renovación (Ver tabla)
    updateType = phpversion
    phpversion Requerido Versión de PHP a aplicar

    Descripción de los campos de respuesta:

    Campo Descripción
    name Nombre del servicio/alojamiento
    status Estado del servicio ( Ver tabla )
    type Tipo de servicio/alojamiento
    productkey Clave del tipo de servicio/alojamiento (Ver tabla)
    tsExpir Fecha de expiración del alojamiento
    updateType = phpversion
    php/enabled (bool) Indica si PHP está activado en el servicio
    php/version Versión de PHP actual
    php/name Texto indicando la versión de PHP actual
    php/available Listado de versiones de PHP disponibles

    Ejemplo con updateType='renewalMode'

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/update",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-test01.com",
            "type": "Basic Hosting Service",
            "productkey": "basic",
            "status": "active",
            "tsExpir": "2015-12-10"
        }
    }

    Ejemplo con updateType='phpversion'

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/update",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example.com",
            "type": "Advanced Hosting Service",
            "productkey": "advanced",
            "status": "renewed",
            "tsExpir": "2022-12-10",
            "php": {
                "enabled": true,
                "version": "7.2",
                "name": "PHP 7.2",
                "available": [
                    "default",
                    "8.0",
                    "7.4",
                    "7.3",
                    "7.2",
                    "7.1",
                    "7.0"
                ]
            }
        }
    }

    7.7 Parking Get Info ( service/parkinggetinfo/ )

    Uso: Obtiene información sobre el servicio de parking

    Petición:

    POST /service/parkinggetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento

    Descripción de los campos de respuesta:

    Campo Descripción
    parking/enabled Indica si el servicio de parking está activo o no

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/parkinggetinfo",
        "version": "1.0.20",
        "responseData": {
            "parking": {
                "enabled": false
            }
        }
    }

    7.8 Parking Update ( service/parkingupdate/ )

    Uso: Modifica el servicio de parking

    Petición:

    POST /service/parkingupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    enabled Requerido (bool) Flag para activar o desactivar el servicio de parking

    Descripción de los campos de respuesta:

    Campo Descripción
    parking/enabled Indica si el servicio de parking está activo o no

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/parkingupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "parking": {
                "enabled": false
            }
        }
    }

    7.9 WebConstructor Login ( service/webconstructorlogin/ )

    Uso: Obtener una URL para realizar un login en el sistema del WebConstructor

    Petición:

    POST /service/webconstructorlogin/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    subdomain Requerido Nombre del subdominio sobre el que publicar la web
    loginlang Opcional en Idioma del login inicial, puede cambiarse en el constructor de webs

    Descripción de los campos de respuesta:

    Campo Descripción
    webcostructor/loginURL URL de login en el WebConstructor

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/webconstructorlogin",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "webconstructor": {
                "loginURL": "http:\/\/editor.webconstructor.site\/en\/?login_hash=XXXXXXXXXXX"
            }
        }
    }

    7.10 FTP List ( service/ftplist/ )

    Uso: Realizar un listado/búsqueda de las cuentas FTP de un cierto servicio

    Petición:

    POST /service/ftplist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    ftp/entityID Identificador
    ftp/name Nombre del ususario FTP
    ftp/ftpPath Path del FTP
    ftp/password Password de la cuenta FTP
    ftp/quota Quota en bytes de la cuenta FTP

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ftplist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 2,
                "total": 2
            },
            "ftp": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "ftp.example-2525.com",
                    "ftpPath": "\/",
                    "password": "caWh678JtG3Bf",
                    "quota": 48576000
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.11 FTP Get Info ( service/ftpgetinfo/ )

    Uso: Obtener información de una cuenta FTP

    Petición:

    POST /service/ftpgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    ftp/entityID Identificador
    ftp/name Nombre del ususario FTP
    ftp/ftpPath Path del FTP
    ftp/password Password de la cuenta FTP
    ftp/quota Quota en bytes de la cuenta FTP

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ftpgetinfo",
        "version": "1.0.20",
        "responseData": {
            "ftp": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "ftp.example-2525.com",
                    "ftpPath": "\/",
                    "password": "caWh678JtG3Bf",
                    "quota": 48576000
                }
            ]
        }
    }

    7.12 FTP Create ( service/ftpcreate/ )

    Uso: Crear una nueva cuenta FTP

    Petición:

    POST /service/ftpcreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    name Requerido Nombre de usuario de la cuenta FTP
    ftpPath Requerido Path de la cuenta FTP
    password Requerido Password de la cuenta FTP
    quota Requerido Bytes de quota de la cuenta FTP ( Min: 1048576 bytes / 1 MByte )

    Descripción de los campos de respuesta:

    Campo Descripción
    ftp/entityID Identificador
    ftp/name Nombre del ususario FTP
    ftp/ftpPath Path del FTP
    ftp/password Password de la cuenta FTP
    ftp/quota Quota en bytes de la cuenta FTP

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ftpcreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "ftp": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "ftp.example-2525.com",
                    "ftpPath": "\/",
                    "password": "caWh678JtG3Bf",
                    "quota": 48576000
                }
            ]
        }
    }

    7.13 FTP Update ( service/ftpupdate/ )

    Uso: Modificar una cuenta FTP

    Petición:

    POST /service/ftpupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    ftpPath Requerido Path de la cuenta FTP
    password Requerido Password de la cuenta FTP
    quota Requerido Bytes de quota de la cuenta FTP ( Min: 1048576 bytes / 1MByte )

    Descripción de los campos de respuesta:

    Campo Descripción
    ftp/entityID Identificador
    ftp/name Nombre del ususario FTP
    ftp/ftpPath Path del FTP
    ftp/password Password de la cuenta FTP
    ftp/quota Quota en bytes de la cuenta FTP

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ftpupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "ftp": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "ftp.example-2525.com",
                    "ftpPath": "\/",
                    "password": "caWh678JtG3Bf",
                    "quota": 48576000
                }
            ]
        }
    }

    7.14 FTP Delete ( service/ftpdelete/ )

    Uso: Borrar una cuenta FTP

    Petición:

    POST /service/ftpdelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ftpdelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.15 DataBase List ( service/ddbblist/ )

    Uso: Realizar un listado/búsqueda de las bases de datos de un cierto servicio

    Petición:

    POST /service/ddbblist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    ddbb/entityID Identificador
    ddbb/name Nombre de la base de datos
    ddbb/user Usuario de acceso a la base de datos
    ddbb/password Password de la Base de datos
    ddbb/externalAccess Flag que indica si se permite acceso externo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ddbblist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 1,
                "total": 1
            },
            "ddbb": [
                {
                    "entityID": "SRV0000214277-000396074",
                    "name": "ddb244864",
                    "user": "ddb244864",
                    "password": "NMXXXXYYkDV53",
                    "externalAccess": false
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.16 DataBase Get Info ( service/ddbbgetinfo/ )

    Uso: Obtener información de una Base de datos

    Petición:

    POST /service/ddbbgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    ddbb/entityID Identificador
    ddbb/name Nombre de la base de datos
    ddbb/user Usuario de acceso a la base de datos
    ddbb/password Password de la Base de datos
    ddbb/externalAccess Flag que indica si se permite acceso externo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ddbbgetinfo",
        "version": "1.0.20",
        "responseData": {
            "ddbb": [
                {
                    "entityID": "SRV0000214277-000396074",
                    "name": "ddb244864",
                    "user": "ddb244864",
                    "password": "NMXXXXYYkDV53",
                    "externalAccess": false
                }
            ]
        }
    }

    7.17 DataBase Create ( service/ddbbcreate/ )

    Uso: Crear una nueva Base de Datos

    Petición:

    POST /service/ddbbcreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    password Requerido Password de la base de datos
    externalAccess Opcional false Indica si se requiere de acceso externo a la BBDD

    Descripción de los campos de respuesta:

    Campo Descripción
    ddbb/entityID Identificador
    ddbb/name Nombre de la base de datos
    ddbb/user Usuario de acceso a la base de datos
    ddbb/password Password de la Base de datos
    ddbb/externalAccess Flag que indica si se permite acceso externo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ddbbcreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "ddbb": [
                {
                    "entityID": "SRV0000214277-000396074",
                    "name": "ddb244864",
                    "user": "ddb244864",
                    "password": "NMXXXXYYkDV53",
                    "externalAccess": false
                }
            ]
        }
    }

    7.18 DataBase Update ( service/ddbbupdate/ )

    Uso: Modificar una base de datos

    Petición:

    POST /service/ddbbupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    password Requerido Password de la base de datos
    externalAccess Opcional false Indica si se requiere de acceso externo a la BBDD

    Descripción de los campos de respuesta:

    Campo Descripción
    ddbb/entityID Identificador
    ddbb/name Nombre de la base de datos
    ddbb/user Usuario de acceso a la base de datos
    ddbb/password Password de la Base de datos
    ddbb/externalAccess Flag que indica si se permite acceso externo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ddbbupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "ddbb": [
                {
                    "entityID": "SRV0000214277-000396074",
                    "name": "ddb244864",
                    "user": "ddb244864",
                    "password": "NMXXXXYYkDV53",
                    "externalAccess": false
                }
            ]
        }
    }

    7.19 DataBase Delete ( service/ddbbdelete/ )

    Uso: Modificar una base de datos

    Petición:

    POST /service/ddbbdelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    entityID Requerido Identificador
    serviceName Requerido Nombre del servicio/alojamiento

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/ddbbdelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.20 Subdomain List ( service/subdomainlist/ )

    Uso: Realizar un listado/búsqueda de los subdominios de un cierto servicio

    Petición:

    POST /service/subdomainlist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro del subdominio

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    subdomain/entityID Identificador
    subdomain/name Nombre del subdominio
    subdomain/ftpPath Path del FTP
    subdomain/ssl Información del Certificado SSL. (Sólo cuando el subdominio tiene un Certificado instalado)
    subdomain/ssl/sslPath Ruta segura del FTP
    subdomain/ssl/sslCert Archivo CRT del certificado
    subdomain/ssl/sslKey Archivo KEY del certificado
    subdomain/ssl/sslCertChain Archivo CA-CRT del certificado

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service/subdomainlist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 2,
                "total": 2
            },
            "subdomain": [
                {
                    "entityID": "SRV0000381923-0000677075",
                    "name": "example.com",
                    "ftpPath": "public/",
                    "ssl": {
                        "ftpPath": "public/",
                        "sslCert": "-----BEGIN CERTIFICATE-----
                                    ....
                                    -----END CERTIFICATE-----",
                        "sslKey": "-----BEGIN PRIVATE KEY-----
                                   ....
                                   -----END PRIVATE KEY-----",
                        "sslCertChain": "-----BEGIN CERTIFICATE-----
                                        ....
                                        -----END CERTIFICATE-----"
                    }
                }, {
                    "entityID": "SRV0000381923-0000421111",
                    "name": "www.example.com",
                    "ftpPath": "public/",
                    "ssl": {
                        "ftpPath": "public/",
                        "sslCert": "-----BEGIN CERTIFICATE-----
                                    ....
                                    -----END CERTIFICATE-----",
                        "sslKey": "-----BEGIN PRIVATE KEY-----
                                   ....
                                   -----END PRIVATE KEY-----",
                        "sslCertChain": "-----BEGIN CERTIFICATE-----
                                        ....
                                        -----END CERTIFICATE-----"
                    }
                }
                /*
                ,{ .... }
                */
            ]
        }
    }

    7.21 Subdomain Get Info ( service/subdomaingetinfo/ )

    Uso: Obtener la información de un subdominio

    Petición:

    POST /service/subdomaingetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    subdomain/entityID Identificador
    subdomain/name Nombre del subdominio
    subdomain/ftpPath Path del FTP

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/subdomaingetinfo",
        "version": "1.0.20",
        "responseData": {
            "subdomain": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test.example-test01.com",
                    "ftpPath": "public-test\/"
                }
            ]
        }
    }

    7.22 Subdomain Create ( service/subdomaincreate/ )

    Uso: Crear una nuevo subdominio

    Petición:

    POST /service/subdomaincreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    name Requerido Nombre del subdominio
    ftpPath Requerido Path FTP
    sslCert Opcional Archivo CRT del certificado
    sslKey Requerido si sslCert es enviado Archivo KEY del certificado
    sslCertChain Requerido si sslCert es enviado Archivo CA-CRT del certificado
    sslPath Requerido si sslCert es enviado Ruta segura del FTP

    Descripción de los campos de respuesta:

    Campo Descripción
    subdomain/entityID Identificador
    subdomain/name Nombre del subdominio
    subdomain/ftpPath Path del FTP
    subdomain/ssl Información del Certificado SSL. (Sólo cuando el subdominio tiene un Certificado instalado)
    subdomain/ssl/sslPath Ruta segura del FTP
    subdomain/ssl/sslCert Archivo CRT del certificado
    subdomain/ssl/sslKey Archivo KEY del certificado
    subdomain/ssl/sslCertChain Archivo CA-CRT del certificado

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service/subdomaincreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "subdomain": [
                {
                    "entityID": "SRV0000382923-0000741936",
                    "name": "test.example.com",
                    "ftpPath": "public/",
                    "ssl": {
                        "ftpPath": "public/",
                        "sslCert": "-----BEGIN CERTIFICATE-----
                                    ....
                                    -----END CERTIFICATE-----",
                        "sslKey": "-----BEGIN PRIVATE KEY-----
                                   ....
                                   -----END PRIVATE KEY-----",
                        "sslCertChain": "-----BEGIN CERTIFICATE-----
                                        ....
                                        -----END CERTIFICATE-----"
                    }
                }
            ]
        }
    }

    7.23 Subdomain Update ( service/subdomainupdate/ )

    Uso: Modificar un subdominio

    Petición:

    POST /service/subdomainupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    ftpPath Requerido Path FTP
    sslCert Opcional Archivo CRT del certificado
    sslKey Requerido si sslCert es enviado Archivo KEY del certificado
    sslCertChain Requerido si sslCert es enviado Archivo CA-CRT del certificado
    sslPath Requerido si sslCert es enviado Ruta segura del FTP

    Descripción de los campos de respuesta:

    Campo Descripción
    subdomain/entityID Identificador
    subdomain/name Nombre del subdominio
    subdomain/ftpPath Path del FTP
    subdomain/ssl Información del Certificado SSL. (Sólo cuando el subdominio tiene un Certificado instalado)
    subdomain/ssl/sslPath Ruta segura del FTP
    subdomain/ssl/sslCert Archivo CRT del certificado
    subdomain/ssl/sslKey Archivo KEY del certificado
    subdomain/ssl/sslCertChain Archivo CA-CRT del certificado

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service/subdomainupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "subdomain": [
                {
                    "entityID": "SRV0000382923-0000423457",
                    "name": "www.example.com",
                    "ftpPath": "public/",
                    "ssl": {
                        "ftpPath": "public/",
                        "sslCert": "-----BEGIN CERTIFICATE-----
                                    ....
                                    -----END CERTIFICATE-----",
                        "sslKey": "-----BEGIN PRIVATE KEY-----
                                   ....
                                   -----END PRIVATE KEY-----",
                        "sslCertChain": "-----BEGIN CERTIFICATE-----
                                        ....
                                        -----END CERTIFICATE-----"
                    }
                }
            ]
        }
    }

    7.24 Subdomain Delete ( service/subdomaindelete/ )

    Uso: Borrar un subdominio

    Petición:

    POST /service/subdomaindelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/subdomaindelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.25 Redirect List ( service/redirectlist/ )

    Uso: Realizar un listado/búsqueda de los redirecciones de un cierto servicio

    Petición:

    POST /service/redirectlist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro del subdominio

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    redirect/entityID Identificador
    redirect/origin Recurso para realizar la redirección
    redirect/destination Destino
    redirect/type Tipo de redirección (Ver tabla)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/redirectlist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 1,
                "total": 1
            },
            "redirect": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "origin": "http:\/\/www.example-test02.net\/test1\/",
                    "destination": "http:\/\/example.com",
                    "type": "301"
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.26 Redirect Get Info ( service/redirectgetinfo/ )

    Uso: Obtener información de una redirección HTTP

    Petición:

    POST /service/redirectgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    redirect/entityID Identificador
    redirect/origin Recurso para realizar la redirección
    redirect/destination Destino
    redirect/type Tipo de redirección (Ver tabla)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/redirectgetinfo",
        "version": "1.0.20",
        "responseData": {
            "redirect": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "origin": "http:\/\/www.example-test02.net\/test1\/",
                    "destination": "http:\/\/example.com",
                    "type": "301"
                }
            ]
        }
    }

    7.27 Redirect Create ( service/redirectcreate/ )

    Uso: Crear una nueva redirección HTTP

    Petición:

    POST /service/redirectcreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    origin Requerido Origen de la redirección
    destination Requerido Destino de la redirección
    type Requerido Tipo de redirección ( Ver Tabla )

    Descripción de los campos de respuesta:

    Campo Descripción
    redirect/entityID Identificador
    redirect/origin Recurso para realizar la redirección
    redirect/destination Destino
    redirect/type Tipo de redirección (Ver tabla)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/redirectcreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "redirect": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "origin": "http:\/\/www.example-test02.net\/test1\/",
                    "destination": "http:\/\/example.com",
                    "type": "301"
                }
            ]
        }
    }

    7.28 Redirect Update ( service/redirectupdate/ )

    Uso: Modificar una redirección HTTP

    Petición:

    POST /service/redirectupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    destination Requerido Destino de la redirección
    type Requerido Tipo de redirección ( Ver Tabla )

    Descripción de los campos de respuesta:

    Campo Descripción
    redirect/entityID Identificador
    redirect/origin Recurso para realizar la redirección
    redirect/destination Destino
    redirect/type Tipo de redirección (Ver tabla)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/redirectupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "redirect": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "origin": "http:\/\/www.example-test02.net\/test1\/",
                    "destination": "http:\/\/example.com",
                    "type": "301"
                }
            ]
        }
    }

    7.29 Redirect Delete ( service/redirectdelete/ )

    Uso: Borrar una redirección

    Petición:

    POST /service/redirectdelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/redirectdelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.30 Mail List ( service/maillist/ )

    Uso: Realizar un listado/búsqueda de las cuentas de correo de un cierto servicio

    Petición:

    POST /service/maillist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    mail/entityID Identificador
    mail/name Nombre del cuenta de correo
    mail/password Password
    mail/usage Ocupación del buzón (En Bytes)
    mail/quotaMax Capacidad del buzón (En Bytes)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/maillist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 2,
                "total": 2
            },
            "mail": [
                {
                    "entityID": "SRV0000255277-0000330053",
                    "name": "test66@example.com",
                    "password": "############",
                    "usage": 1123234,
                    "quotaMax": 16106127360
                },
                {
                    "entityID": "SRV0000255277-0000330053",
                    "name": "test66@example.com",
                    "password": "############",
                    "usage": 1123234,
                    "quotaMax": 16106127360
                }
    
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.31 Mail Get Info ( service/mailgetinfo/ )

    Uso: Obtener información de una cuenta de correo

    Petición:

    POST /service/mailgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    mail/entityID Identificador
    mail/name Nombre del cuenta de correo
    mail/password Password
    mail/usage Ocupación del buzón (En Bytes)
    mail/quotaMax Capacidad del buzón (En Bytes)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailgetinfo",
        "version": "1.0.20",
        "responseData": {
            "mail": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "hola@example123.com",
                    "password": "############",
                    "usage": 1123234,
                    "quotaMax": 16106127360
                }
            ]
        }
    }

    7.32 Mail Create ( service/mailcreate/ )

    Uso: Crear una nueva cuenta de correo

    Petición:

    POST /service/mailcreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    name Requerido Nombre de usuario de la cuenta de correo
    password Requerido Password de la cuenta

    Descripción de los campos de respuesta:

    Campo Descripción
    mail/entityID Identificador
    mail/name Nombre del cuenta de correo
    mail/password Password
    mail/usage Ocupación del buzón (En Bytes)
    mail/quotaMax Capacidad del buzón (En Bytes)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailcreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "mail": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "hola@example123.com",
                    "password": "############",
                    "usage": 0,
                    "quotaMax": 16106127360
                }
            ]
        }
    }

    7.33 Mail Update ( service/mailupdate/ )

    Uso: Modificar una cuenta de correo

    Petición:

    POST /service/mailupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    password Requerido Password de la cuenta

    Descripción de los campos de respuesta:

    Campo Descripción
    mail/entityID Identificador
    mail/name Nombre del cuenta de correo
    mail/password Password
    mail/usage Ocupación del buzón (En Bytes)
    mail/quotaMax Capacidad del buzón (En Bytes)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "mail": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "hola@example123.com",
                    "password": "############",
                    "usage": 1123234,
                    "quotaMax": 16106127360
                }
            ]
        }
    }

    7.34 Mail Delete ( service/maildelete/ )

    Uso: Borrar una cuenta de correo

    Petición:

    POST /service/maildelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/maildelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.35 Mail Alias List ( service/mailaliaslist/ )

    Uso: Realizar un listado/búsqueda de los alias de correo de un cierto servicio

    Petición:

    POST /service/mailaliaslist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    mailalias/entityID Identificador
    mailalias/name Nombre del aliasde correo
    mailalias/target Cuentas de redirección del alias

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailaliaslist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 2,
                "total": 2
            },
            "mailalias": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test2@example123.com",
                    "target": [
                        "info@g123mail.com",
                        "asdf@foo.com"
                    ]
                },
                {
                    "entityID": "SRV0000214277-000396073",
                    "name": "test4@example1234.com",
                    "target": [
                        "info@foo-foo.com",
                        "info2@foo-foo.com"
                        "var1232@barfoo.com"
                    ]
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.36 Mail Alias Get Info ( service/mailaliasgetinfo/ )

    Uso: Obtener información de un alias de correo

    Petición:

    POST /service/mailaliasgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    mailalias/entityID Identificador
    mailalias/name Nombre del alias de correo
    mailalias/target Cuentas de redirección del alias

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailaliasgetinfo",
        "version": "1.0.20",
        "responseData": {
            "mailalias": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test2@example123.com",
                    "target": [
                        "info@g123mail.com",
                        "asdf@foo.com"
                    ]
                }
            ]
        }
    }

    7.37 Mail Alias Create ( service/mailaliascreate/ )

    Uso: Crear un nuevo alias de correo

    Petición:

    POST /service/mailaliascreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    name Requerido Nombre de usuario del alias de correo
    target Requerido Lista de cuentas de correo de destino ( separado por ,)

    Descripción de los campos de respuesta:

    Campo Descripción
    mailalias/entityID Identificador
    mailalias/name Nombre del alias de correo
    mailalias/target Cuentas de redirección del alias

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailaliascreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "mailalias": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test2@example123.com",
                    "target": [
                        "info@g123mail.com",
                        "asdf@foo.com"
                    ]
                }
            ]
        }
    }

    7.38 Mail Alias Update ( service/mailaliasupdate/ )

    Uso: Modificar un alias de correo

    Petición:

    POST /service/mailaliasupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    target Requerido Lista de cuentas de correo de destino ( separado por ,)

    Descripción de los campos de respuesta:

    Campo Descripción
    mailalias/entityID Identificador
    mailalias/name Nombre del aliasde correo
    mailalias/target Cuentas de redirección del alias

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailaliasupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "mailalias": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test2@example123.com",
                    "target": [
                        "info@g123mail.com",
                        "test@g123mail.com",
                        "asdf@foo.com"
                    ]
                }
            ]
        }
    }

    7.39 Mail Alias Delete ( service/mailaliasdelete/ )

    Uso: Borrar un alias de correo

    Petición:

    POST /service/mailaliasdelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/mailaliasdelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.40 DNS Zone List ( service/dnslist/ )

    Uso: Realizar un listado/búsqueda de las zona DNS de un cierto servicio

    Petición:

    POST /service/dnslist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    serviceName Requerido Nombre del servicio/alojamiento
    filter Opcional Filtro
    filterType Opcional Filtro por tipo
    filterValue Opcional Filtro por valor

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    dns/entityID Identificador
    dns/name Nombre de la zona DNS
    dns/type Tipo de zona DNS ( Ver Tabla )
    dns/ttl Time to Live ("-" = Por defecto)
    dns/priority Prioridad de la zona ("-" = por defecto)
    dns/value Valor de la zona según el tipo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnslist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 3,
                "total": 20
            },
            "dns": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "example000003.com",
                    "type": "A",
                    "ttl": "-",
                    "priority": "-",
                    "value": "127.0.0.1"
                },
                {
                    "entityID": "SRV0000214277-000396073",
                    "name": "*.example000003.com",
                    "type": "CNAME",
                    "ttl": "-",
                    "priority": "-",
                    "value": "srv21.example25.com"
                },
                {
                    "entityID": "SRV0000214277-000396074",
                    "name": "www.example000003.com",
                    "type": "CNAME",
                    "ttl": "-",
                    "priority": "-",
                    "value": "srv21.example25.com"
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    7.41 DNS Zone Get Info ( service/dnsgetinfo/ )

    Uso: Obtener información de la zona DNS

    Petición:

    POST /service/dnsgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción
    dns/entityID Identificador
    dns/name Nombre de la zona DNS
    dns/type Tipo de zona DNS ( Ver Tabla )
    dns/ttl Time to Live ("-" = Por defecto)
    dns/priority Prioridad de la zona ("-" = por defecto)
    dns/value Valor de la zona según el tipo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnsgetinfo",
        "version": "1.0.20",
        "responseData": {
            "dns": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "_aaa._tls.domainmanagement.sexy",
                    "type": "SRV",
                    "ttl": "-",
                    "priority": "10",
                    "value": "10 8080 srv.example.es"
                }
            ]
        }
    }

    7.42 DNS Zone Create ( service/dnscreate/ )

    Uso: Crear una nueva zona DNS

    Petición:

    POST /service/dnscreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    name Requerido Nombre de la zona DNS
    type Requerido Tipo de zona DNS ( Ver tabla )
    value Requerido Valor de la zona según tipo ( Ver tabla )
    ttl Opcional Time To Live
    priority Opcional 10 si el tipo es MX o SRV Prioridad de zona

    Descripción de los campos de respuesta:

    Campo Descripción
    dns/entityID Identificador
    dns/name Nombre de la zona DNS
    dns/type Tipo de zona DNS ( Ver Tabla )
    dns/ttl Time to Live ("-" = Por defecto)
    dns/priority Prioridad de la zona ("-" = por defecto)
    dns/value Valor de la zona según el tipo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnscreate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "dns": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "_aaa._tls.domainmanagement.sexy",
                    "type": "SRV",
                    "ttl": "-",
                    "priority": "10",
                    "value": "10 8080 srv.example.es"
                }
            ]
        }
    }

    7.43 DNS Zone Update ( service/dnsupdate/ )

    Uso: Modificar una zona DNS

    Petición:

    POST /service/dnsupdate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador
    value Requerido Valor de la zona según tipo ( Ver tabla )
    ttl Opcional Time To Live
    priority Opcional 10 si el tipo es MX o SRV Prioridad de zona

    Descripción de los campos de respuesta:

    Campo Descripción
    dns/entityID Identificador
    dns/name Nombre de la zona DNS
    dns/type Tipo de zona DNS ( Ver Tabla )
    dns/ttl Time to Live ("-" = Por defecto)
    dns/priority Prioridad de la zona ("-" = por defecto)
    dns/value Valor de la zona según el tipo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnsupdate",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "dns": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "_aaa._tls.domainmanagement.sexy",
                    "type": "SRV",
                    "ttl": "-",
                    "priority": "10",
                    "value": "10 8080 srv.example.es"
                }
            ]
        }
    }

    7.44 DNS Zone Delete ( service/dnsdelete/ )

    Uso: Borrar una zona DNS

    Petición:

    POST /service/dnsdelete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    entityID Requerido Identificador

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnsdelete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.45 DNS Zone Restore ( service/dnsrestore/ )

    Uso: Restaura a los valores por defecto todas las zonas DNS

    Petición:

    POST /service/dnsrestore/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnsrestore",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.46 DNS Zone Set ( service/dnssetzone/ )

    Uso: Modifica con un solo comando toda la zona DNS, implica un borrado de la zona existente.

    Petición:

    POST /service/dnssetzone/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento
    dnsZoneData Requerido Zona DNS en formato JSON y codificada en Base64 (Ver ejemplo )

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de zona DNS en format JSON:

    [{"name":"example001.com","type":"A","ttl":"-","priority":"-","value":"8.1.1.18"},{"name":"*.example001.com","type":"CNAME","ttl":"-","priority":"-","value":"srv1.example1111.com"} /*...*/ ] 
    
    /* Luego hay que codificar el JSON en Base64 y poner el resultado en el campo dnsZoneData */

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnsrestore",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.47 DNS Zone Delete All ( service/dnsdeleteall/ )

    Uso: Borra todas las zonas DNS

    Petición:

    POST /service/dnsdeleteall/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    serviceName Requerido Nombre del servicio/alojamiento

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/dnsdeleteall",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.48 Tablas de Servicios asociadas

    7.48.1 Tipos de servicios

    Clave de producto Producto/Servicio
    redir Servicio de Redirección y Parking
    mini Alojamiento Mini
    mail Alojamiento Mail
    mailplus Alojamiento Mail Plus
    mailpro Alojamiento Mail Pro
    basic Alojamiento Básico
    professional Alojamiento Profesional
    advanced Alojamiento Avanzado
    corporate Alojamiento Corporativo

    7.48.2 Estados de los servicios

    Estado Definición
    init Servicio en proceso
    active Servicio activo
    inactive Inactivo
    renewed Renovación en proceso
    renewable Servicio activo en periodo de renovación

    7.48.3 Modos de renovación

    Keyword Definición
    autorenew Autorenovación automática
    manual Renovación manual

    7.48.4 Tipos de redirección

    Tipo Definición
    301 Permanent (HTTP 301)
    302 Temporary (HTTP 302)
    frame Frame

    7.48.5 Tipos de DNS

    Tipo Definición Formato del valor
    A Address IPv4
    AAAA Address IPv6 IPv6
    CNAME Canonical Name Nombre de host
    MX Mail Exchange Nombre de host del servidor de correo
    SRV Service Formato weight port destiny-host
    TXT Text Texto
    NS NameServer Nombre de host del servidor DNS
    CAA Certification Authority Formato flag tag "valor"

    8 Modulo: SSL

    El módulo ssl permite el acceso a diferentes opciones sobre los Certificados SSL

    Acciones disponibles:

    Acción Credenciales Descripción
    /ssl/csrdecode/ Requeridas Decodificar un CSR
    /ssl/csrcreate/ Requeridas Crear un CSR
    /ssl/productlist/ Requeridas Listado de productos
    /ssl/productgetinfo/ Requeridas Obtener información de un producto
    /ssl/list/ Requeridas Listado de Certificados comprados
    /ssl/getinfo/ Requeridas Obtener información sobre un Certificado comprado
    /ssl/create/ Requeridas Enviar una petición de creación de un Certificado SSL con un CSR
    /ssl/renew/ Requeridas Renueva un Certificado SSL
    /ssl/reissue/ Requeridas Reemite un Certificado SSL
    /ssl/multidomainaddsan Requeridas Añade un Dominio SAN (Nombre Alternativo) al Certificado
    /ssl/getvalidationemails/ Requeridas Listado de los correos de validación del Certificado y sus métodos alternativos
    /ssl/changevalidationmethod/ Requeridas Modifica el método de validación de un CommonName que está en process o reissue
    /ssl/resendvalidationmail/ Requeridas Reenvía el correo de validación de un CommonName de un Certificado

    8.1 CSR Decode ( ssl/csrdecode/ )

    Uso: Decodificar los parámetros de un CSR.

    Petición:

    POST /ssl/csrdecode/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    csrData Requerido Datos del código CSR (incluyendo las lineas ---BEGIN--- y ---END--

    Descripción de los campos de respuesta:

    Campo Descripción
    csrData Datos de CSR enviados
    commonName Nombre común
    organizationName Nombre de la organización
    organizationalUnitName Nombre de unidad asociado al CSR
    countryName Código de 2 caracteres del país
    stateOrProvinceName Nombre de la provincia o estado de la compañía
    localityName Nombre de la población de la compañía
    emailAddress Correo electrónico asociado al CSR

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/csrdecode",
        "version": "1.0.20",
        "responseData": {
            "csrData": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC7zCCAdcCAQAwgakxGzAZBgNVBAMMEmV4YW1wbGUuZG9tYWluLmNvbTEbMBkG\nA1UECgwSVGVjaCBTb2x1dGlvbnMgSW5jMRowGAYDVQQLDBFHb3RoYW0gRGVwYXJ0\nbWVudDELMAkGA1UEBhMCVVMxEDAOBgNVBAgMB0FyaXpvbmExETAPBgNVBAcMCEJh\ncGNodWxlMR8wHQYJKoZIhvcNAQkBFhBpbmZvQGV4YW1wbGUuY29tMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6HWtKvCB\/v\/bE5mD9ZpQuuI1Hbx9FsvJ\nO4mFUj+1kzH4bJTIWEKt3qiwpy+HirqonHvgriXyZyq52uhJANrXh13c2qJrd5zQ\ndL2Cvi301+C7QH5grA2RfMxNAfLRDEOYI+uw5xxMM8YNZexJeQlAmq6bFPZUUqEO\nw4JzT4kw1HK6umxV8ycOyOh50gYckzdzlrOHDrdCJ3+H31CFCRjEe3KVTcvpG6Nf\nI5czXLIUYWmHw7i9e0uQIbBMiDkMRVQ9RvS5rjPK+kHPLHblapAJPs2xm5Ow+FSg\n805uDqmjZ1sz7u1aw9cPkNGDmHXTyStJu440byRnZtto7dIFF8pKcQIDAQABoAAw\nDQYJKoZIhvcNAQEFBQADggEBAHVPoIXS0vtwt8QoQ7iAoa9T+Ypn7hEErbw1amLT\nrYy5GtzIN6fesTZcCv\/1OuOXTQFXQYGMtVVjUCsF50qLdaHRV8jTl7f0b9raP+Fv\nb7d0VLtQx3o3LeSR4IS\/C7VpxXqm6lSOSs2R6W5eZ0ot+4K+8wxJZmaY4trCe2dY\nOVrEcQbLIWc1lTl71wrbIIzyfiGz9xAK+\/Sqf8uv8wtylcTvL1pgBUVJ7XcFzSsl\nBBGXsjseGF9+\/uIZH0mEgO8GN0UC+deNc71KZTwhpuFwo\/hXF7sJtGVt5szX8HBD\nJ724\/s79fnNYwqowoKBXm1bIMZS2D0IEX\/M7nX2\/u1EQE0k=\n-----END CERTIFICATE REQUEST-----",
            "commonName": "example.domain.com",
            "organizationName": "Tech Solutions Inc",
            "organizationalUnitName": "Gotham Department",
            "countryName": "US",
            "stateOrProvinceName": "Arizona",
            "localityName": "Bapchule",
            "emailAddress": "info@example.com"
        }
    }

    8.2 CSR Create ( ssl/csrcreate/ )

    Uso: Crea un CSR.

    Petición:

    POST /ssl/csrcreate/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    commonName Requerido Nombre común
    organizationName Requerido Nombre de la organización
    organizationalUnitName Requerido Nombre de unidad asociado al CSR
    countryName Requerido Código de 2 caracteres del país
    stateOrProvinceName Requerido Nombre de la provincia o estado de la compañía
    localityName Requerido Nombre de la población de la compañía
    emailAddress Requerido Correo electrónico asociado al CSR

    Descripción de los campos de respuesta:

    Campo Descripción
    csrData Datos de CSR enviados
    csrKey KEY generada a partir del CSR enviado
    commonName Nombre común
    organizationName Nombre de la organización
    organizationalUnitName Nombre de unidad asociado al CSR
    countryName Código de 2 caracteres del país
    stateOrProvinceName Nombre de la provincia o estado de la compañía
    localityName Nombre de la población de la compañía
    emailAddress Correo electrónico asociado al CSR

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/csrcreate",
        "version": "1.0.20",
        "responseData": {
            "csrData": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC7zCCAdcCAQAwgakxGzAZBgNVBAMMEmV4YW1wbGUuZG9tYWluLmNvbTEbMBkG\nA1UECgwSVGVjaCBTb2x1dGlvbnMgSW5jMRowGAYDVQQLDBFHb3RoYW0gRGVwYXJ0\nbWVudDELMAkGA1UEBhMCVVMxEDAOBgNVBAgMB0FyaXpvbmExETAPBgNVBAcMCEJh\ncGNodWxlMR8wHQYJKoZIhvcNAQkBFhBpbmZvQGV4YW1wbGUuY29tMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8PWaH\/\/AL1HMpjcPEaBdXqAvQND0UAUC\nV66QYwE3Eqc\/OogYA\/Uc\/kR2ecNbBxD0nSghGiTbt0LIXTaDXtmGCs28pYOF\/zr9\n9NAfHypqIuCay8hmMTXabbXFnhm5dMly9h5jeOCSh2hXKX1u72u9fUugAL\/cpodi\nipJENgvreliT5bib4O2fBgsuWiNgkhRAmc1JAboKE46vREouX66cWsUSWhiVJMXS\nI+B0uTNk3\/I4DeglJkqldR\/JMeXJf88JPZup5rxdvXDp4Y5TgL0ObAkTyJ8JFhsE\ngYBe0Zur7rFdGHkNnCDnbkWF2Gr1nnusuIpi4c3cV+THsT\/nxcDwwwIDAQABoAAw\nDQYJKoZIhvcNAQEFBQADggEBAET2miFah2elumEJbLNDc1AhukXyZ9eVZ96FusSV\nxQL2F2CS0EWHZha3qf1yeIw5\/m\/KD8OqiCtQjOJF5UGxHPhXAUbPFVVcJDHVPZ\/h\niC3VpYrkk4OsqnlyYbjCWm+5k7Lp8zP+B3L4cPgH7ESL8HSwEDwH0NSanOPmX2bo\ndYYYFFzZCWTTNWUWjW0D+jDWSnGdi7wqjI2D7sOGiwgGKSG6G1m7Ij44sw7T8cL9\nycvrAZ+Tp29IajVUwBcg8E02J96KO6HH3slI6ux7\/KD0K0lHDzTO9aWgP6kGbERg\n7iY1+OYQ6ZTBX1aJG7IYyB7hm2OctaTKtF242j2+ZjH3nVI=\n-----END CERTIFICATE REQUEST-----",
            "csrKey": "-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDw9Zof\/8AvUcym\nNw8RoF1eoC9A0PRQBQJXrpBjATcSpz86iBgD9Rz+RHZ5w1sHEPSdKCEaJNu3Qshd\nNoNe2YYKzbylg4X\/Ov300B8fKmoi4JrLyGYxNdpttcWeGbl0yXL2HmN44JKHaFcp\nfW7va719S6AAv9ymh2KKkkQ2C+t6WJPluJvg7Z8GCy5aI2CSFECZzUkBugoTjq9E\nSi5frpxaxRJaGJUkxdIj4HS5M2Tf8jgN6CUmSqV1H8kx5cl\/zwk9m6nmvF29cOnh\njlOAvQ5sCRPInwkWGwSBgF7Rm6vusV0YeQ2cIOduRYXYavWee6y4imLhzdxX5Mex\nP+fFwPDDAgMBAAECggEBAKeVaRgQO42tinOfn29W5RlGtxaRPRnaIgLxeaIh2jey\n8hq3RFycQQnme6+72rdTZ41Vt5ADSnxuigOqQjvZdYxWAnnqu2sDkFSP2tVGHoMb\nSw2n1ssq9TuQTFzk70L2SGo8QFp1dfOO8e\/9OQZzHFrkGefriH6ZckOF7sLYD3IK\nh3O0kdLJOCECFjW0HTtCfToIDUksu1gPlLQF0K6YMefvlEM37Qr\/wyMzyRsutcIs\nxjPP5AVs8+eIwfNq\/i0mgQXgrfi9opLSNFGRV502n13EG2wymE5+h8UqgOLlEnAs\nW5xSusF7hyuxj3x8vAT31aG3IpJ12Avkm4\/1lzR8faECgYEA+v4cmGRikI7M8JH4\nrTYYlcvrIaLZHWDmqRmXac080prqIGlto\/yaJT6ONaJbE9buEf8T8jDbsBdMHS9e\nd6D2KqPoCemCpnU96KRGmjDNtlnJVNpM7TyqhdxJaqiJ7K1rSS8bfcNrnZv3Ec0U\nwq6HWvHnzIALIT5Sn3T1GjXQFTUCgYEA9cQ\/cfSVmWILlbzJNEXPipAHAHmf0LNn\nXNfDHoBJezUkUWHlMeMyCzD+J4z44w8oXJog918bpaeIt45xBktJY7WSiIyVSotH\nQGR\/GI2\/sL4Mpsc9tPLx4thsos2fKbyeak\/dWoiU44QH5Ghd\/ehzmN9A51chxTjo\nRbrtMR6xBRcCgYASXxk+ulJQnHM5xKV8IDKKfGOYka\/sq5QWmo3vq5shGz+54Z2p\n3Cp4QWztVhXujNPeM1qFZrgd2oayuC3k+b4q\/tZUK2hpwLkoVyXn0VytVUMcV+I7\nly4wICCrkuyNi2AH+k+709sDrU\/XWLiFS3sS2BQMbu7hnwszKr9qDLhPZQKBgQCw\n0nGTW5YGtTQAl8NriI658sYW4WrKjUlg0xvfZg14R9PJedWc\/wmSY714V0T6mH1B\nouL1F8icdt02s5U+Igy7YHf9JqiC6ZJqEeQfllzEnPgdRlxvRBwkSfJfb\/GD5eFU\nPAHWkU4OI4BKJYz6kbQZ2Qapa1cwvrDe+o6NOLfEIQKBgQCjFFRORtW16XS7tGab\nN\/bdTY51iR0OCssyuzrBO8PbhSPkspRU2gSQQi1aPsDlQo0GdNOAvpfoGbfy4mTV\n+84pJRb455T3gV\/crLR3bBMSkuaH+k0MoM0k9hHlUN\/\/FRiXx9v69iLdgXM7qrpx\nNjW7iwzuXUoiDPvfS80Kp6ZBZg==\n-----END PRIVATE KEY-----",
            "commonName": "example.domain.com",
            "organizationName": "Tech Solutions Inc",
            "organizationalUnitName": "Gotham Department",
            "countryName": "US",
            "stateOrProvinceName": "Arizona",
            "localityName": "Bapchule",
            "emailAddress": "info@example.com"
        }
    }

    8.3 Product List ( ssl/productlist/ )

    Uso: Muestra un listado de los Certificados SSL disponibles

    Petición:

    POST /ssl/productlist/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    wildcard Opcional (Bool) Filtrará por tipos que permitan Wildcard
    multidomain Opcional (Bool) Filtrará por tipos que permitan Multi-dominio
    trial Opcional (Bool) Filtrará por Certificados Trial
    validationType Opcional Filtrará por el tipo de validación (Ver tabla)

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    products Listado de Certificados SSL que cumplen con los filtros indicados
    products/productID Identificador del producto
    products/productName Nombre del producto
    products/brandName Marca del producto
    products/validationType Tipo de validación del Certificado (Ver tabla)
    products/isMultiDomain Si el Certificado es Multi-dominio
    products/isWildcard Si el Certificado es Wildcard
    products/isTrial Si el Certificado es Trial
    products/numDomains Número de dominios que permite el Certificado SSL
    products/keyLength Longitud en bits de la clave RSA del Certificado
    products/encryption Tipo de encriptación del Certificado
    products/create Información sobre la creación del Certificado SSL
    products/create/create Coste de creación del Certificado SSL
    products/create/years Años del Certificado SSL
    products/create/isPromo Indica si el Certificado SSL dispone de una promo
    Sólo cuando es true
    products/renew Información sobre la renovación del Certificado SSL
    products/renew/create Coste de la renovación del Certificado SSL
    products/renew/years Años del Certificado SSL
    products/renew/isPromo Indica si el Certificado SSL dispone de una promo
    Sólo cuando es true
    products/trialPeriod Número de días de validez del Certificado SSL (Sólo para Certificados SSL Trial)
    products/sanMaxDomains Máximo de dominios alternativos que permite el Certificado SSL (Sólo para Certificados SSL Multi-dominio)
    products/sanPrice Coste de un dominio alternativo en el Certificado SSL (Sólo para Certificados SSL Multi-dominio)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl/productlist",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 46,
                "total": 46
            },
            "products": [
                {
                    "productID": 1,
                    "productName": "Comodo Domain Premium",
                    "brandName": "Comodo",
                    "validationType": "dv",
                    "isMultiDomain": false,
                    "isWildcard": false,
                    "isTrial": false,
                    "numDomains": 1,
                    "keyLength": 2048,
                    "encryption": 256,
                    "create": {
                        "create": 4.95,
                        "years": 1,
                        "isPromo": true
                    },
                    "renew": {
                        "create": 39.95,
                        "years": 1
                    }
                }
                    /*
                    ,{ .... }
                    */
            ]
        }
    }

    Ejemplo de Certificados Trial

    {
        "productID": 58,
        "productName": "DonDominio Trial SSL",
        "brandName": "DonDominio",
        "validationType": "dv",
        "isMultiDomain": false,
        "isWildcard": false,
        "isTrial": true,
        "numDomains": 1,
        "keyLength": 2048,
        "encryption": 256,
        "trialPeriod": "90 days"
    }

    Ejemplo de Certificados Multi-dominio

    {
        "productID": 17,
        "productName": "Comodo Multi-Domain EV SSL",
        "brandName": "Comodo",
        "validationType": "ev",
        "isMultiDomain": true,
        "isWildcard": false,
        "isTrial": false,
        "numDomains": 3,
        "keyLength": 2048,
        "encryption": 256,
        "create": {
            "create": 383.95,
            "years": 1
        },
        "renew": {
            "create": 383.95,
            "years": 1
        },
        "sanMaxDomains": 210,
        "sanPrice": 106
    }

    8.4 Product Get Info ( ssl/productgetinfo/ )

    Uso: Obtiene información sobre un producto en concreto

    Petición:

    POST /ssl/productgetinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    productID Requerido Identificador de un producto

    Descripción de los campos de respuesta:

    Campo Descripción
    productID Identificador del producto
    productName Nombre del producto
    brandName Marca del producto
    validationType Tipo de validación del Certificado (Ver tabla)
    isMultiDomain Si el Certificado es Multi-dominio
    isWildcard Si el Certificado es Wildcard
    isTrial Si el Certificado es Trial
    numDomains Número de dominios que permite el Certificado SSL
    keyLength Longitud en bits de la clave RSA del Certificado
    encryption Tipo de encriptación del Certificado
    create Información sobre la creación del Certificado SSL
    create/create Coste de creación del Certificado SSL
    create/years Años del Certificado SSL
    create/isPromo Indica si el Certificado SSL dispone de una promo
    Sólo cuando es true
    renew Información sobre la renovación del Certificado SSL
    renew/create Coste de la renovación del Certificado SSL
    renew/years Años del Certificado SSL
    renew/isPromo Indica si el Certificado SSL dispone de una promo
    Sólo cuando es true
    trialPeriod Número de días de validez del Certificado SSL (Sólo para Certificados SSL Trial)
    sanMaxDomains Máximo de dominios alternativos que permite el Certificado SSL (Sólo para Certificados SSL Multi-dominio)
    sanPrice Coste de un dominio alternativo en el Certificado SSL (Sólo para Certificados SSL Multi-dominio)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/productgetinfo",
        "version": "1.0.20",
        "responseData": {
            "productID": 55,
            "productName": "DonDominio Domain SSL",
            "brandName": "DonDominio",
            "validationType": "dv",
            "isMultiDomain": false,
            "isWildcard": false,
            "isTrial": false,
            "numDomains": 1,
            "keyLength": 2048,
            "encryption": 256,
            "create": {
                "create": 4.95,
                "years": 1,
                "isPromo": true
            },
            "renew": {
                "create": 4.95,
                "years": 1
            }
     }
    }

    8.5 List ( ssl/list/ )

    Use: Listado de Certificados comprados mediante filtros.

    Petición:

    POST /ssl/list/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    productID Opcional Filtra por identificador de producto (Ver /ssl/productlist/
    status Opcional Filtra por el estado del Certificado (Ver tabla)
    renewable Opcional (Bool) Filtra si el Certificado es renovable o no
    commonName Opcional Filtra por el CommonName del Certificado

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    ssl Listado de Certificados SSL que cumplen con los filtros indicados
    ssl/certificateID Identificador del Certificado
    ssl/commonName CommonName
    ssl/status Estado del Certificado
    ssl/renewable Si el Certificado es renovable
    ssl/productID Identificador del Producto
    ssl/sanMaxDomains Número máximo de dominios.
    Sólo en Certificados multi-domain
    ssl/tsCreate Fecha de creación del Certificado
    ssl/tsExpir Fecha de expiración del Certificado
    ssl/alternativeNames Dominios alternativos del Certificado

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl/list",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 2,
                "results": 2,
                "total": 20
            },
            "ssl": [
                {
                    "certificateID": 132442,
                    "commonName": "www.example.org",
                    "status": "valid",
                    "renewable": false,
                    "productID": 6,
                    "sanMaxDomains": 200,
                    "tsCreate": "2021-05-19",
                    "tsExpir": "2022-05-19",
                    "alternativeNames": [
                        "example.org",
                        "www.example.org"
                    ]
                },
                {
                    "certificateID": 130839,
                    "commonName": "*.example.com",
                    "status": "valid",
                    "renewable": false,
                    "productID": 56,
                    "sanMaxDomains": 200,
                    "tsCreate": "2021-05-06",
                    "tsExpir": "2022-06-07",
                    "alternativeNames": [
                        "*.example.com",
                        "example.com"
                    ]
                }
            ]
        }
    }

    8.6 Get Info ( ssl/getinfo/ )

    Uso: Obtiene información acerca de un Certificado en concreto

    Petición:

    POST /ssl/getinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    certificateID Requerido Identificador del Certificado
    infoType Opcional status Información del Certificado (Ver siguiente tabla)
    pfxpass Opcional Permite enviar la contraseña cuando infoType=pfx

    Opciones del InfoType

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    status String No Información general del Certificado
    ssldata String No Datos del Certificados, archivos CRT, KEY y CA-CRT
    validationStatus String No Información sobre la validación del Certificado. Sólo cuando el estado del Certificado es process o reissue
    pfx String No Datos del Certificados en formato pfx
    der String No Datos del Certificados en formato der
    p7b String No Datos del Certificados en formato p7b
    zip String No Datos del Certificados en formato zip
    pem String No Datos del Certificados en formato pem

    Descripción de los campos de respuesta:

    Campo Descripción
    certificateID Identificador del Certificado
    commonName CommonName
    status Estado del Certificado
    renewable Si el Certificado es renovable
    productID Identificador del Producto
    numDomains Número máximo de dominios. Incluye los nombres alternativos.
    Sólo en Certificados multi-domain
    tsCreate Fecha de creación del Certificado
    tsExpir Fecha de expiración del Certificado
    alternativeNames Dominios alternativos del Certificado
    sslCert Archivo CRT del Certificado
    sslKey Archivo KEY del Certificado
    sslCertChain Archivo CA-CRT del Certificado
    fingerprint Fingerprint del Certificado.
    Only on infoType=ssldata
    content Datos del Certificado en algún formato. (Check infoType options)
    content/type Mimetype del archivo del Certificado
    content/name Nombre del archivo del Certificado
    content/base64encoded (bool) Si el Certificado está codificado en base64
    content/data Contenido del archivo del Certificado
    validationData Información relativa a la validación del Certificado
    validationData/dcv Control de validación del dominio
    validationData/organizationValidationStatus Estado de la validación de empresa. Sólo en tipos de validaicón OV y EV
    validationData/brandValidationStatus Estado de validación de la marca de empresa. Sólo en tipos de validaicón OV y EV
    validationData/message Breve descripción del estado de validación
    validationData/externalValidation Si el Certificado precisa de validación externa o no

    Ejemplo de respuesta:

    Ejemplo infoType = status

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "certificateID": 130839,
            "commonName": "*.example.com",
            "status": "valid",
            "renewable": false,
            "productID": 56,
            "numDomains": 200,
            "tsCreate": "2021-05-06",
            "tsExpir": "2022-06-07",
            "alternativeNames": [
                "*.example.com",
                "example.com"
            ]
        }
    }

    Ejemplo infoType = ssldata

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "certificateID": 130839,
            "commonName": "*.example.com",
            "status": "valid",
            "renewable": false,
            "productID": 56,
            "numDomains": 200,
            "tsCreate": "2021-05-06",
            "tsExpir": "2022-06-07",
            "alternativeNames": [
                "*.example.com",
                "example.com"
            ],
            "sslCert": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
            "sslKey": "-----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY-----",
            "sslCertChain": [
                "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----"
            ],
            "fingerprint": {
                "SHA1": "A7:65:F0:57:24:45:40:B1:F0:80:D2:89:A4:FF:81:53:7A:9A:6C:35",
                "SHA256": "01:98:0E:C8:4F:DA:14:0B:2C:03:FA:E7:E5:4E:79:BD:D6:15:22:70:AA:F0:BC:21:C2:BC:16:76:81:8C:8F:5A",
                "MD5": "C7:6B:A7:2E:45:ED:55:26:38:D9:7D:0B:AF:47:09:BD"
            }
        }
    }

    Ejemplo infoType = validationStatus

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "certificateID": 135820,
            "commonName": "www.example.com",
            "status": "process",
            "renewable": false,
            "productID": 55,
            "tsCreate": "",
            "tsExpir": "",
            "alternativeNames": [],
            "validationData": {
                "dcv": {
                    "www.example.com": {
                        "validated": false,
                        "domainName": "www.example.com",
                        "method": "dns",
                        "checkvalue": "_6e14527a114d52f9901f0d46.www.example.com CNAME 96a5500ed20516ba7a1efa94bf90a.a1ec45f78dbd349c33a05c6e8e8d0a50.ssl135820.comodoca.com"
                    }
                },
                "organizationValidationStatus": "",
                "brandValidationStatus": "",
                "message": "The petition is pending validation.",
                "externalValidation": true
            }
        }
    }

    Example infoType = pfx, infoType = der, infoType = p7b, infoType = zip, infoType = pem

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "certificateID": 130839,
            "commonName": "*.example.com",
            "status": "valid",
            "renewable": false,
            "productID": 56,
            "numDomains": 200,
            "tsCreate": "2021-05-06",
            "tsExpir": "2022-06-07",
            "alternativeNames": [
                "*.example.com",
                "example.com"
            ],
            "sslCert": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----",
            "sslKey": "-----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY-----",
            "sslCertChain": [
                "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----"
            ],
            // infoType=pfx
            "content": {
                    "type": "application\/x-pkcs12",
                    "name": "certificate.pfx",
                    "base64encoded": true,
                    "data": "MIIMvQIBAz23HCBAhOeNzRgCTm7Q=="
            },
            // infoType=der
            "content": {
                "type": "application\/x-x509-ca-cert",
                    "name": "certificate.der",
                    "base64encoded": true,
                    "data": "MIIGgzCCBWugAwIBAgIRAKalTxP\/"
            },
            // infoType=p7b
            "content": {
                "type": "text\/plain",
                    "name": "certificate.p7b",
                    "base64encoded": false,
                    "data": "-----BEGIN PKCS7-----\nMIIWigXpNpaYbqEAMQA=\n-----END PKCS7-----\n"
            },
            // infoType=zip
            "content": {
                "type": "application\/zip",
                    "name": "certificate.zip",
                    "base64encoded": true,
                    "data": "UEsDBBQAAACYGgAAAAA="
            },
            // infoType=pem
            "content": {
                "type": "text\/plain",
                "name": "certificate.pem",
                "base64encoded": false,
                "data": "-----BEGIN CERTIFICATE-----\nMIIGgzCCBWu==\n-----END CERTIFICATE-----"
            }
        }
    }

    8.7 Create ( ssl/create/ )

    Uso: Envia una petición de creación de un Certificado SSL con un CSR

    Petición:

    POST /ssl/create/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    csrData Requerido Datos de CSR (incluyendo -----BEGIN----- y -----END-----)
    productID Requerido Identificador del producto
    period Opcional minYears del Producto (Integer) Años de expedición (Revisar información sobre minYears y maxYears)
    keyData Opcional Datos de KEY (incluyendo -----BEGIN----- y -----END-----)
    adminContact[Data] Requerido Información del contacto administrativo (Revisar la sección Especificar contactos).
    techContact[Data] Opcional Información del contacto técnico. Si no es indicado, la información del contacto administrativo será utilizada.
    orgContact[Data] Requerido
    si el validationType ='OV' o validationType = 'EV'
    Información del contacto de empresa.
    Información de los productos
    Tipos de validación.
    validationMethod Opcional dns Método de validación del certificado para el dominio indicando en el CommonName
    alt_name_[Number] Opcional Sólo para Certificados Multi-dominio: Nombre Alternativo del certificado. Cada uno de los Nombres Alternativos deben estar indicados con una numeración y su respectivo campo alt_validation_. El número de Nombres Alternativos no puede superar el valor de sanMaxDomains del Producto. (Revisar sección Validación de los Nombres Alternativos).
    alt_validation_[Number] Opcional dns Sólo para Certificados Multi-dominio: Método de validación del Nombre Alternativo. Cada uno de los Nombres Alternativos debe tener su propio campo alt_validation_ . Tipos de validación.

    8.7.1 Especificar contactos

    La información de los contactos adminContact[Data], techContact[Data] y/o orgContact[Data] puede ser facilitada de dos formas:

    1. Indicando el ID de contacto: (Ejemplo para el contacto admin)

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    adminContactID Requerido ID del contacto en DonDominio. Ejemplo: XXX-12312
    1. Facilitar toda la información necesaria: (Ejemplo para el contacto admin)

      En este caso, el adminContactID no debe ser indicaido, ya que sino los siguientes campos serían ignorados.

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    adminContactType Requerido Tipo de contacto: individual o organization
    adminContactFirstName Requerido Nombre del contacto
    adminContactLastName Requerido Apellidos del contacto
    adminContactOrgName Requerido
    si adminContactType = organization
    Nombre de la empresa
    adminContactOrgType Requerido
    si adminContactType = organization
    y adminContactCountry = ES
    Tipo de organización española (Ver tabla)
    adminContactIdentNumber Requerido Número de identificación fiscal, VAT Number, etc...
    adminContactEmail Requerido Correo electrónico del contacto
    adminContactPhone Requerido Número de teléfono del contacto en formato +DD.DDDDDDDD
    adminContactFax Opcional Número de teléfono del contacto en formato +DD.DDDDDDDD
    adminContactAddress Requerido Dirección del contacto
    adminContactPostalCode Requerido Código Postal del contacto
    adminContactCity Requerido Estado/Provincia del contacto
    adminContactState Requerido State/Province
    adminContactCountry Requerido (String 2 letras) Código de país (Ver tabla)

    El resto de contactos se pueden especificar cambiando el prefijo de los parámetros de admin, tech o org.

    8.7.2 Validación de los Nombres Alternativos

    En los Certificados multi-dominio, los Nombres Alternativos deben indicarse en la solicitud de creación con su respectivo método de validación. Como el tipo de Certificado permite más de un Nombre Alternativo, deben estar enumerados:

    Ejemplo con 2 Nombres Alternativos

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    alt_name_1 Requerido Primer Nombre Alternativo
    alt_validation_1 Requerido dns Método de validación del primero Nombre Alternativo
    alt_name_2 Requerido Segundo Nombre Alternativo
    alt_validation_2 Requerido dns Método de validación del segundo Nombre Alternativo

    8.7.3 Respuesta

    Descripción de los campos de respuesta:

    Campo Descripción
    billing Información de facturación sobre la solicitud de creación
    billing/total Importe total de la solicitud
    billing/currency Moneda que representa el total
    ssl Lista de Certificados SSL que cumplen con los filtros indicados
    ssl/certificateID Identificador del certificado
    ssl/commonName Nombre común
    ssl/status Estado del certificado
    ssl/renewable Si el certificado se puede renovar
    ssl/productID Identificador de producto
    ssl/tsCreate Fecha de creación del certificado
    ssl/tsExpir Fecha de vencimiento del certificado
    ssl/alternativeNames Certificar dominios alternativos

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl/create",
        "version": "1.0.20",
        "responseData": {
            "billing": {
                "total": 48.34,
                "currency": "EUR"
            },
            "ssl": {
                "certificateID": 135520,
                "commonName": "www.example.com",
                "status": "process",
                "renewable": false,
                "productID": 1,
                "tsCreate": "",
                "tsExpir": "",
                "alternativeNames": []
            }
        }
    }

    8.8 Renew ( ssl/renew/ )

    Uso: Renueva un Certificado SSL

    Petición:

    POST /ssl/renew/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    csrData Requerido Datos de CSR (incluyendo -----BEGIN----- y -----END-----)
    certificateID Requerido Identificador del certificado
    period Opcional minYears del Producto (Integer) Años de expedición (Revisar información sobre minYears y maxYears)
    keyData Opcional Datos de KEY (incluyendo -----BEGIN----- y -----END-----)
    adminContact[Data] Requerido Información del contacto administrativo (Revisar la sección Especificar contactos).
    techContact[Data] Opcional Información del contacto técnico. Si no es indicado, la información del contacto administrativo será utilizada.
    orgContact[Data] Requerido
    si el validationType ='OV' o validationType = 'EV'
    Información del contacto de empresa.
    Información de los productos
    Tipos de validación.
    validationMethod Opcional dns Método de validación del certificado para el dominio indicando en el CommonName
    alt_name_[Number] Opcional Sólo para Certificados Multi-dominio: Nombre Alternativo del certificado. Cada uno de los Nombres Alternativos deben estar indicados con una numeración y su respectivo campo alt_validation_. El número de Nombres Alternativos no puede superar el valor de sanMaxDomains del Producto. (Revisar sección Validación de los Nombres Alternativos).
    alt_validation_[Number] Opcional dns Sólo para Certificados Multi-dominio: Método de validación del Nombre Alternativo. Cada uno de los Nombres Alternativos debe tener su propio campo alt_validation_ . Tipos de validación.

    8.8.1 Especificar contactos

    La información de los contactos adminContact[Data], techContact[Data] y/o orgContact[Data] puede ser facilitada de dos formas:

    1. Indicando el ID de contacto: (Ejemplo para el contacto admin)

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    adminContactID Requerido ID del contacto en DonDominio. Ejemplo: XXX-12312
    1. Facilitar toda la información necesaria: (Ejemplo para el contacto admin)

      En este caso, el adminContactID no debe ser indicaido, ya que sino los siguientes campos serían ignorados.

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    adminContactType Requerido Tipo de contacto: individual o organization
    adminContactFirstName Requerido Nombre del contacto
    adminContactLastName Requerido Apellidos del contacto
    adminContactOrgName Requerido
    si adminContactType = organization
    Nombre de la empresa
    adminContactOrgType Requerido
    si adminContactType = organization
    y adminContactCountry = ES
    Tipo de organización española (Ver tabla)
    adminContactIdentNumber Requerido Número de identificación fiscal, VAT Number, etc...
    adminContactEmail Requerido Correo electrónico del contacto
    adminContactPhone Requerido Número de teléfono del contacto en formato +DD.DDDDDDDD
    adminContactFax Opcional Número de teléfono del contacto en formato +DD.DDDDDDDD
    adminContactAddress Requerido Dirección del contacto
    adminContactPostalCode Requerido Código Postal del contacto
    adminContactCity Requerido Estado/Provincia del contacto
    adminContactState Requerido State/Province
    adminContactCountry Requerido (String 2 letras) Código de país (Ver tabla)

    El resto de contactos se pueden especificar cambiando el prefijo de los parámetros de admin, tech o org.

    8.8.2 Validación de los Nombres Alternativos

    En los Certificados multi-dominio, los Nombres Alternativos deben indicarse en la solicitud de renovación con su respectivo método de validación. Como el tipo de Certificado permite más de un Nombre Alternativo, deben estar enumerados:

    Ejemplo con 2 Nombres Alternativos

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    alt_name_1 Requerido Primer Nombre Alternativo
    alt_validation_1 Requerido dns Método de validación del primero Nombre Alternativo
    alt_name_2 Requerido Segundo Nombre Alternativo
    alt_validation_2 Requerido dns Método de validación del segundo Nombre Alternativo

    8.8.3 Respuesta

    Descripción de los campos de respuesta:

    Campo Descripción
    billing Información de facturación sobre la solicitud de renovación
    billing/total Importe total de la solicitud
    billing/currency Moneda que representa el total
    ssl Lista de Certificados SSL que cumplen con los filtros indicados
    ssl/certificateID Identificador del certificado
    ssl/commonName Nombre común
    ssl/status Estado del certificado
    ssl/renewable Si el certificado se puede renovar
    ssl/productID Identificador de producto
    ssl/tsCreate Fecha de creación del certificado
    ssl/tsExpir Fecha de vencimiento del certificado
    ssl/alternativeNames Certificar dominios alternativos
    ssl/sanMaxDomains Máximo de dominios alternativos que permite el Certificado SSL (Sólo para Certificados SSL Multi-dominio)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/renew",
        "version": "1.0.20",
        "responseData": {
            "billing": {
                "total": 95.35,
                "currency": "EUR"
            },
            "ssl": {
                "certificateID": 135838,
                "commonName": "example.com",
                "status": "process",
                "renewable": false,
                "productID": 4,
                "tsCreate": "",
                "tsExpir": "",
                "alternativeNames": [],
                "sanMaxDomains": 6
            }
        }
    }

    8.9 Reissue ( ssl/reissue/ )

    Use Reemite un Certificado SSL.

    Petición:

    POST /ssl/reissue/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    csrData Requerido Datos de CSR (incluyendo -----BEGIN----- y -----END-----)
    certificateID Requerido Identificador del certificado
    keyData Opcional Datos de KEY (incluyendo -----BEGIN----- y -----END-----)
    validationMethod Opcional dns Método de validación del certificado para el dominio indicando en el CommonName
    alt_name_[Number] Opcional Sólo para Certificados Multi-dominio: Nombre Alternativo del certificado. Cada uno de los Nombres Alternativos deben estar indicados con una numeración y su respectivo campo alt_validation_. El número de Nombres Alternativos no puede superar el valor de sanMaxDomains del Producto. (Revisar sección Validación de los Nombres Alternativos).
    alt_validation_[Number] Opcional dns Sólo para Certificados Multi-dominio: Método de validación del Nombre Alternativo. Cada uno de los Nombres Alternativos debe tener su propio campo alt_validation_ . Tipos de validación.

    8.9.1 Validación de los Nombres Alternativos

    En los Certificados multi-dominio, los Nombres Alternativos deben indicarse en la solicitud de reemisión con su respectivo método de validación. Como el tipo de Certificado permite más de un Nombre Alternativo, deben estar enumerados:

    Ejemplo con 2 Nombres Alternativos

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    alt_name_1 Requerido Primer Nombre Alternativo
    alt_validation_1 Requerido dns Método de validación del primero Nombre Alternativo
    alt_name_2 Requerido Segundo Nombre Alternativo
    alt_validation_2 Requerido dns Método de validación del segundo Nombre Alternativo

    8.9.2 Response

    Descripción de los campos de respuesta:

    Campo Descripción
    certificateID Identificador del certificado
    commonName Nombre común
    status Estado del certificado
    renewable Si el certificado se puede renovar
    productID Identificador de producto
    tsCreate Fecha de creación del certificado
    tsExpir Fecha de vencimiento del certificado
    alternativeNames Certificar dominios alternativos
    sanMaxDomains Máximo de dominios alternativos que permite el Certificado SSL (Sólo para Certificados SSL Multi-dominio)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/reissue",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "certificateID": 135815,
            "commonName": "www.ejemplo.com",
            "status": "reissue",
            "renewable": false,
            "productID": 57,
            "tsCreate": "2021-06-18",
            "tsExpir": "2022-07-19",
            "alternativeNames": [
                "www.ejemplo.com",
                "www.ejemplo.eu",
                "mail.ejemplo.com"
            ],
            "sanMaxDomains": 3
        }
    }

    8.10 Multidomain Add San ( ssl/multidomainaddsan/ )

    Use: Añade un Dominio SAN (Nombre Alternativo) al Certificado.

    Petición:

    POST /ssl/multidomainaddsan/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    certificateID Requerido Identificador del certificado
    extraSAN Requerido Nombre alternativo que será añadido al Certificado SSL

    8.10.1 Respuesta

    Descripción de los campos de respuesta:

    Campo Descripción
    billing Información de facturación sobre la solicitud de renovación
    billing/total Importe total de la solicitud
    billing/currency Moneda que representa el total
    ssl Lista de Certificados SSL que cumplen con los filtros indicados
    ssl/certificateID Identificador del certificado
    ssl/commonName Nombre común
    ssl/status Estado del certificado
    ssl/renewable Si el certificado se puede renovar
    ssl/productID Identificador de producto
    ssl/tsCreate Fecha de creación del certificado
    ssl/tsExpir Fecha de vencimiento del certificado
    ssl/alternativeNames Certificar dominios alternativos
    ssl/sanMaxDomains Máximo de dominios alternativos que permite el Certificado SSL (Sólo para Certificados SSL Multi-dominio)

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/multidomainaddsan",
        "version": "1.0.20",
        "responseData": {
            "billing": {
                "total": 96.32,
                "currency": "EUR"
            },
            "ssl": {
                "certificateID": 135785,
                "commonName": "www.test.es",
                "status": "valid",
                "renewable": false,
                "productID": 57,
                "tsCreate": "2021-06-18",
                "tsExpir": "2022-07-19",
                "alternativeNames": [
                    "www.test.es",
                    "www.test2.es",
                    "www.test3.es",
                    "www.test4.com",
                    "www.scip-test01.com",
                    "www.scip-test01.es",
                    "www.scip-test02.com",
                    "www.scip-test03.com",
                    "www.scip-test04.es",
                    "www.scip-test05.es",
                    "www.scip-test06.com",
                    "www.scip-test07.com",
                    "www.scip-test08.com",
                    "www.scip-test09.com",
                    "www.scip-test10.com",
                    "www.scip-test10.es",
                    "www.scip-test11.com",
                    "www.scip-test12.com"
                ],
                "sanMaxDomains": 18
            }
        }
    }

    8.11 Get Validation Emails ( ssl/getvalidationemails/ )

    Uso: Listado de los correos de validación del Certificado y sus métodos alternativos

    Petición:

    POST ssl/getvalidationemails/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    commonName Requerido CommonName del Certificado.
    includeAlternativeMethods Opcional true (bool) La respuesta incluye métodos alternativos de validación aparte de los correos.

    Descripción de los campos de respuesta:

    Campo Descripción
    commonName CommonName del Certificado.
    valMethods Listado de métodos de validación del Certificado.

    Respuesta con includeAlternativeMethods = false

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/getvalidationemails",
        "version": "1.0.20",
        "responseData": {
            "commonName": "example.com",
            "valMethods": [
                "admin@example.com",
                "administrator@example.com",
                "hostmaster@example.com",
                "webmaster@example.com",
                "postmaster@example.com"
            ]
        }
    }

    Respuesta con includeAlternativeMethods = true

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/getvalidationemails",
        "version": "1.0.20",
        "responseData": {
            "commonName": "example.com",
            "valMethods": [
                "dns",
                "http",
                "https",
                "admin@example.com",
                "administrator@example.com",
                "hostmaster@example.com",
                "webmaster@example.com",
                "postmaster@example.com"
            ]
        }
    }

    8.12 Change Validation Method ( ssl/changevalidationmethod/ )

    Uso: Modifica el método de validación de un CommonName que está en process o reissue.

    Petición:

    POST ssl/changevalidationmethod/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    certificateID Requerido Identificador del Certificado
    commonName Requerido CommonName
    validationMethod Requerido Nuevo método de validación

    Descripción de los campos de respuesta:

    Campo Descripción
    certificateID Identificador del Certificado
    commonName CommonName
    status Estado del Certificado
    renewable Si el Certificado es renovable
    productID Identificador del Producto
    tsCreate Fecha de creación del Certificado
    tsExpir Fecha de expiración del Certificado
    alternativeNames Dominios alternativos del Certificado
    validationData Información relativa a la validación del Certificado
    validationData/dcv Control de validación del dominio
    validationData/organizationValidationStatus Estado de la validación de empresa. Sólo en tipos de validaicón OV y EV
    validationData/brandValidationStatus Estado de validación de la marca de empresa. Sólo en tipos de validaicón OV y EV
    validationData/message Breve descripción del estado de validación
    validationData/externalValidation Si el Certificado precisa de validación externa o no

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/changevalidationmethod",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "certificateID": 135820,
            "commonName": "www.example.com",
            "status": "process",
            "renewable": false,
            "productID": 55,
            "tsCreate": "",
            "tsExpir": "",
            "alternativeNames": [],
            "validationData": {
                "dcv": {
                    "www.example.com": {
                        "validated": false,
                        "domainName": "www.example.com",
                        "method": "https",
                        "checkvalue": {
                            "link": "https:\/\/www.example.com\/.well-known\/pki-validation\/6E14527A118BF6D03F4D52F9901F0D46.txt",
                            "file": "6E14527A118BF6D03F4D52F9901F0D46.txt",
                            "contents": "96a5500ed2051a7a1efa94bf90aa1ec45f78dbd349c33a05c6e8e8d0a50\ncomodoca.com\nssl135820"
                        }
                    }
                },
                "organizationValidationStatus": "",
                "brandValidationStatus": "",
                "message": "The petition is pending validation.",
                "externalValidation": true
            }
        }
    }

    8.13 Resend Validation Mail ( ssl/resendvalidationmail/ )

    Uso: Reenvía el correo de validación de un CommonName de un Certificado.

    Petición:

    POST ssl/resendvalidationmail/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    certificateID Requerido Identificador del Certificado
    commonName Requerido CommonName

    Descripción de los campos de respuesta:

    Campo Descripción
    certificateID Identificador del Certificado
    commonName CommonName
    status Estado del Certificado
    renewable Si el Certificado es renovable
    productID Identificador del Producto
    tsCreate Fecha de creación del Certificado
    tsExpir Fecha de expiración del Certificado
    alternativeNames Dominios alternativos del Certificado
    validationData Información relativa a la validación del Certificado
    validationData/dcv Control de validación del dominio
    validationData/organizationValidationStatus Estado de la validación de empresa. Sólo en tipos de validaicón OV y EV
    validationData/brandValidationStatus Estado de validación de la marca de empresa. Sólo en tipos de validaicón OV y EV
    validationData/message Breve descripción del estado de validación
    validationData/externalValidation Si el Certificado precisa de validación externa o no

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "ssl\/resendvalidationmail",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "certificateID": 135763,
            "commonName": "www.example.com",
            "status": "process",
            "renewable": false,
            "productID": 2,
            "tsCreate": "",
            "tsExpir": "",
            "alternativeNames": [],
            "validationData": {
                "dcv": {
                    "www.example.com": {
                        "validated": false,
                        "domainName": "www.example.com",
                        "method": "mail",
                        "checkvalue": "admin@example.com"
                    }
                },
                "organizationValidationStatus": "",
                "brandValidationStatus": "",
                "message": "The petition is pending validation.",
                "externalValidation": true
            }
        }
    }

    8.14 Tablas de Certificados SSL asociadas

    8.14.1 Tipos de validación de los Certificados SSL

    Tipo de validación Producto/Servicio
    dv Validación de dominio
    ov Validación de organización
    ev Validación extendida

    8.14.2 Estados de los Certificados SSL

    Estado del certificado Información
    process En proceso
    valid Válido
    expired Expirado
    renew Renovación en proceso
    reissue En proceso de reemisión
    cancel Cancelado

    8.14.3 Tipos de validación del CommonName

    Tipo de validación de CommonName Información
    mail Validación por correo electrónico
    dns Validación mediante registro dns en la zona dns del dominio
    http Validación mediante protocolo http. Una URL específica debe mostrar un archivo específico con contenido específico
    https Validación mediante protocolo https. Una URL específica debe mostrar un archivo específico con contenido específico

    9 Módulo: User

    El módulo de user permite la gestión de los usuarios externos en la cuenta.

    Acciones disponibles:

    Action Authentication Description
    /user/create/ Requerida Crea un usuario externo
    /user/list/ Requerida Lista todos los usuarios externos de la cuenta
    /user/getinfo Requerida Obtiene información sobre un usuario en concreto
    /user/updatestatus/ Requerida Actualiza el estado de un usuario
    /user/updatepassword/ Requerida Actualiza la contraseña de un usuario
    /user/adddomain/ Requerida Añade un dominio a un usuario
    /user/updatedomain/ Requerida Actualiza los permisos de un dominio
    /user/deletedomain/ Requerida Elimina un dominio de un usuario
    /user/delete/ Requerida Elimina un usuario externo

    9.1 Create ( user/create/ )

    Uso: Crea un usuario externo.

    Petición:

    POST /user/create/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requeridos Nombre de usuario del usuario externo
    password Requeridos Contraseña del usuario externo

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/create",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "username": "test3",
            "status": "enabled",
            "lastLogin": "",
            "numDomains": 0
        }
    }

    9.2 List ( user/list/ )

    Uso: Lista todos los usuarios externos de la cuenta.

    Petición:

    POST /user/list/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    pageLength Opcional 1000 Máximo número de resultados
    page Opcional 1 Número de página de los resultados obtenidos
    status Opcional Estado del usuario externo (Ver tabla)
    username Opcional Buscar usuarios por el nombre de usuario
    domainName Opcional Buscar por los dominios de los usuarios

    Descripción de los campos de respuesta:

    Campo Descripción
    queryInfo Datos de la consulta realizada
    queryInfo/page Número de pagina de los resultados
    queryInfo/pageLength Número de resultados máximo por página
    queryInfo/results Número de resultados obtenidos
    queryInfo/total Número total de resultados
    users Información de usuarios
    users/username Nombre de usuario
    users/status Estado del usuario
    users/lastlogin Día del último acceso
    users/numDomains Dominios asociados al usuario

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/list",
        "version": "1.0.20",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 1,
                "total": 1
            },
            "users": [
                {
                    "username": "admin1",
                    "status": "enabled",
                    "lastLogin": "2020-05-14",
                    "numDomains": 4
                }
            ]
        }
    }

    9.3 Get Info ( user/getinfo/ )

    Uso: Obtiene información sobre un usuario en concreto.

    Petición:

    POST /user/getinfo/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario
    domains Listado de dominios asociados al usuario y su respectivo permiso

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/getinfo",
        "version": "1.0.20",
        "responseData": {
            "username": "admin1",
            "status": "enabled",
            "lastLogin": "2020-05-14",
            "numDomains": 4,
            "domains": {
                "example.tv": {
                    "domain_ownercontacts": "write",
                    "domain_contacts": "write",
                    "domain_dns": "write",
                    "domain_gluerecords": "write",
                    "domain_dnssec": "write",
                    "domain_transferblock": "disabled",
                    "domain_authcode": "read",
                    "domain_others": "write",
                    "service_ftp": "write",
                    "service_subdomains": "write",
                    "service_redirects": "write",
                    "service_parking": "write",
                    "service_dnszone": "write",
                    "service_ddbb": "write",
                    "servicemail_accounts": "write",
                    "servicemail_alias": "write"
                },
                ....
            }
        }
    }

    9.4 Update Status ( user/updatestatus/ )

    Uso: Actualiza el estado de un usuario.

    Petición:

    POST /user/updatestatus/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario
    status Requerido Estado del usuario a aplicar (Ver tabla)

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario
    domains Listado de dominios asociados al usuario y su respectivo permiso

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/updatestatus",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "username": "admin1",
            "status": "enabled",
            "lastLogin": "2020-05-14",
            "numDomains": 4,
            "domains": {
                "example.tv": {
                    "domain_ownercontacts": "write",
                    "domain_contacts": "write",
                    "domain_dns": "write",
                    "domain_gluerecords": "write",
                    "domain_dnssec": "write",
                    "domain_transferblock": "disabled",
                    "domain_authcode": "read",
                    "domain_others": "write",
                    "service_ftp": "write",
                    "service_subdomains": "write",
                    "service_redirects": "write",
                    "service_parking": "write",
                    "service_dnszone": "write",
                    "service_ddbb": "write",
                    "servicemail_accounts": "write",
                    "servicemail_alias": "write"
                },
                ....
    
            }
        }
    }
    
    

    9.5 Update Password ( user/updatepassword/ )

    Uso: Actualiza la contraseña de un usuario.

    Petición:

    POST /user/updatepassword/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario
    password Requerido Contraseña a aplicar

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario
    domains Listado de dominios asociados al usuario y su respectivo permiso

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/updatepassword",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "username": "admin1",
            "status": "enabled",
            "lastLogin": "2020-05-14",
            "numDomains": 4,
            "domains": {
                "example.tv": {
                    "domain_ownercontacts": "write",
                    "domain_contacts": "write",
                    "domain_dns": "write",
                    "domain_gluerecords": "write",
                    "domain_dnssec": "write",
                    "domain_transferblock": "disabled",
                    "domain_authcode": "read",
                    "domain_others": "write",
                    "service_ftp": "write",
                    "service_subdomains": "write",
                    "service_redirects": "write",
                    "service_parking": "write",
                    "service_dnszone": "write",
                    "service_ddbb": "write",
                    "servicemail_accounts": "write",
                    "servicemail_alias": "write"
                },
                ....
    
            }
        }
    }

    9.6 Add Domain ( user/adddomain/ )

    Uso: Añade un dominio a un usuario.

    Petición:

    POST /user/adddomain/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario
    domainName Requerido Dominio a añadir
    [Permiso]=[valor] Opcional Por defecto los permisos son creados con el valor por defecto del sistema El permiso a aplicar (Ver tabla)

    Ejemplo del parámetro de permisos

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    domain_ownercontacts=read Opcional El usuario podrá ver la información del contacto titular del dominio, pero no modificarlo

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario
    domains Listado de dominios asociados al usuario y su respectivo permiso

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/adddomain",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "username": "admin1",
            "status": "enabled",
            "lastLogin": "2020-05-14",
            "numDomains": 3,
            "domains": {
                "example.tv": {
                    "domain_ownercontacts": "read",
                    "domain_contacts": "write",
                    "domain_dns": "write",
                    "domain_gluerecords": "write",
                    "domain_dnssec": "write",
                    "domain_transferblock": "disabled",
                    "domain_authcode": "read",
                    "domain_others": "write",
                    "service_ftp": "write",
                    "service_subdomains": "write",
                    "service_redirects": "write",
                    "service_parking": "write",
                    "service_dnszone": "write",
                    "service_ddbb": "write",
                    "servicemail_accounts": "write",
                    "servicemail_alias": "write"
                },
                ....
    
            }
        }
    }

    9.7 Update Domain ( user/updatedomain/ )

    Uso: Actualiza los permisos de un dominio.

    Petición:

    POST /user/updatedomain/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario
    domainName Requerido Dominio a actualizar
    [Permiso]=[valor] Opcional Por defecto los permisos son creados con el valor por defecto del sistema El permiso a aplicar (Ver tabla)

    Ejemplo del parámetro de permisos

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    domain_ownercontacts=read Opcional El usuario podrá ver la información del contacto titular del dominio, pero no modificarlo

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario
    domains Listado de dominios asociados al usuario y su respectivo permiso

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/updatedomain",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "username": "admin1",
            "status": "enabled",
            "lastLogin": "2020-05-14",
            "numDomains": 3,
            "domains": {
                "example.tv": {
                    "domain_ownercontacts": "read",
                    "domain_contacts": "write",
                    "domain_dns": "write",
                    "domain_gluerecords": "write",
                    "domain_dnssec": "write",
                    "domain_transferblock": "disabled",
                    "domain_authcode": "read",
                    "domain_others": "write",
                    "service_ftp": "write",
                    "service_subdomains": "write",
                    "service_redirects": "write",
                    "service_parking": "write",
                    "service_dnszone": "write",
                    "service_ddbb": "write",
                    "servicemail_accounts": "write",
                    "servicemail_alias": "write"
                },
                ....
    
            }
        }
    }

    9.8 Delete Domain ( user/deletedomain/ )

    Uso: Elimina un dominio de un usuario.

    Petición:

    POST /user/deletedomain/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario
    domainName Requerido Dominio a eliminar

    Descripción de los campos de respuesta:

    Campo Descripción
    username Nombre de usuario
    status Estado del usuario
    lastlogin Día del último acceso
    numDomains Dominios asociados al usuario
    domains Listado de dominios asociados al usuario y su respectivo permiso

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/deletedomain",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "username": "admin1",
            "status": "enabled",
            "lastLogin": "2020-05-14",
            "numDomains": 3,
            "domains": {
                "example.tv": {
                    "domain_ownercontacts": "write",
                    "domain_contacts": "write",
                    "domain_dns": "write",
                    "domain_gluerecords": "write",
                    "domain_dnssec": "write",
                    "domain_transferblock": "disabled",
                    "domain_authcode": "read",
                    "domain_others": "write",
                    "service_ftp": "write",
                    "service_subdomains": "write",
                    "service_redirects": "write",
                    "service_parking": "write",
                    "service_dnszone": "write",
                    "service_ddbb": "write",
                    "servicemail_accounts": "write",
                    "servicemail_alias": "write"
                },
                ....
    
            }
        }
    }

    9.9 Delete ( user/delete/ )

    Uso: Elimina un usuario externo.

    Petición:

    POST /user/delete/

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    apiuser Requerido Nombre de usuario
    apipasswd Requerido Contraseña de usuario
    username Requerido Nombre de usuario

    Descripción de los campos de respuesta:

    Campo Descripción

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "user\/delete",
        "version": "1.0.20",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": []
    }

    9.10 Tablas de Usuarios asociadas

    9.10.1 Listado de permisos sobre los dominios

    Permiso Información
    domain_ownercontacts Contacto titular del dominio
    domain_contacts Resto de contactos del dominio
    domain_dns DNS del dominio
    domain_gluerecords Glue Records del dominio
    domain_dnssec DNSSEC del dominio
    domain_transferblock Bloqueo de transferéncia del dominio
    domain_authcode AuthCode/EPP del dominio. No permite write
    domain_others Otras opciones del dominio
    service_ftp Servicio FTP
    service_subdomains Subdominios del dominio
    service_redirects Redirecciones
    service_parking Acceso al servicio de parking
    service_dnszone Gestión de la zona dns
    service_ddbb Gestión de la base de datos
    servicemail_accounts Gestión de las cuentas de correo
    servicemail_alias Gestión de los alias de correo

    9.10.2 Permisos de usuarios sobre dominios

    Valor Información
    disabled Permisos desactivados
    read Permisos para lectura
    write Permisos para lectura y escritura

    9.10.3 Estados de los usuarios

    Estado del usuario Información
    enabled Usuario activado
    disabled Usuario desactivado

    10 Anexo I

    10.1 Tablas

    10.1.1 Códigos de error

    A continuación encontrarás los códigos de error que puedes obtener como respuesta a una petición, ten en cuenta que algunos códigos son específicos para cierto tipo de operaciones.

    Código Descripción
    0 Correcto
    1 Error no definido
    100 Error de sintaxis
    101 Error de sintaxis: falta de parámetro
    102 Objeto o acción no válido
    103 Objeto o acción no permitido
    104 Objeto o acción no implementado
    105 Error de sintaxis: parámetro no válido
    200 Se requiere inicio de sesión
    201 Inicio de sesión no válido
    210 Sesión no válida
    300 Acción no permitida
    1000 Cuenta bloqueada
    1001 Cuenta eliminada
    1002 Cuenta inactiva
    1003 Cuenta inexistente
    1004 Contraseña de cuenta no válida
    1005 Contraseña de cuenta no válida
    1006 Cuenta bloqueada
    1007 Cuenta filtrada
    1009 Contraseña de cuenta no válida
    1010 Cuenta bloqueada
    1011 Cuenta bloqueada
    1012 Cuenta bloqueada
    1013 Cuenta bloqueada
    1014 Cuenta filtrada
    1030 Cuenta baneada
    1100 Balance insuficiente
    2001 Nombre de dominio no válido
    2002 TLD no soportado
    2003 TLD en mantenimiento
    2004 Error de comprobación de dominio
    2005 Transferencia de dominio no permitida
    2006 Whois de dominio no permitido
    2007 Error de whois de dominio
    2008 Dominio no encontrado
    2009 Error de creación de domino
    2010 Error de creación de dominio: ya existente
    2011 Error de creación de dominio: dominio premium
    2012 Error de transferencia de dominio
    2100 Error de renovación de dominio
    2101 Renovación de dominio no permitida
    2102 Renovación de dominio bloqueada
    2200 Error de actualización de dominio
    2201 Actualización de dominio no permitida
    2202 Actualización de dominio bloqueada
    2210 Operación inválida debido al estado de la verificación del contacto titular
    3001 Contacto no existente
    3002 Error de datos de contacto
    3003 Operación inválida debido al estado de verificación del contacto
    3500 El usuario no existe
    3501 Error al crear usuario
    3502 Error al actualizar usuario
    4001 Servicio no encontrado
    4002 Entidad del servicio no encontrada
    4003 Error por número máximo de entidades (FTP/Mails/etc..)
    4004 Fallo en la creación de la entidad
    4005 Fallo en la modificación de la entidad
    4006 Fallo en el borrado de entidad
    4007 Fallo en la creación del servicio
    4008 Fallo en la ampliación del servicio
    4009 Fallo en la renovación del servicio
    4010 Error de modificación de sistema de parking
    5000 Error de SSL
    5001 SSL No encontrado
    10001 Error de Webconstructor

    10.1.2 Country codes

    Puedes consultar la tabla de códigos de país ( en formato ISO 3166-1 alfa-2) en Country Codes.

    10.1.3 Tipos de empresa / organización (Contactos "ES")

    Puedes consultar la tabla de tipos de empresa / organización para los contactos con pais ES (España) en Formas jurídicas españolas.

    10.2 Ejemplos

    10.2.1 PHP

    Recuerda que puedes escargar nuestro completo SDK para PHP desde nuestro repositorio de Github.

    <?php
    define( 'DD_API_USER', 'xxxxxx' );
    define( 'DD_API_PASSWD', 'yyyyyyy' );
    define( 'DD_API_URL', 'https://simple-api.dondominio.net' );
    define( 'DD_API_PORT', 443 );
    
    function DDAPI_Query( $query, $data = array() )
    {
        $formData = array_merge( array(
                    'apiuser'       => DD_API_USER,
                    'apipasswd'     => DD_API_PASSWD,
                    ), is_array( $data ) ? $data : array()  );
        $url = DD_API_URL.'/'.trim( $query, '/' ).'/';
        $ch = curl_init();
        curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
        curl_setopt( $ch, CURLOPT_URL, $url);
        curl_setopt( $ch, CURLOPT_PORT, DD_API_PORT );
        curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, 1 );
        curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, 2 );
        curl_setopt( $ch, CURLOPT_POST, true );
        curl_setopt( $ch, CURLOPT_POSTFIELDS, $formData );
        $response = curl_exec( $ch );
        curl_close( $ch );
        if( strlen( $response ) && ( $responseObject = @json_decode( $response ))) {
            return $responseObject;
        }
        return false;
    }
    
    $response = DDAPI_Query( '/tool/idnconverter/', array( 'query' => 'España' ) );
    //print_r( $response );
    
    if( $response ) {
        echo "SUCCESS: ".( $response->success ? "YES" : "NO")."\n";
        if( $response->success ) {
            echo "PunyCode: ".$response->responseData->punycode."\n";
        }
    }
    ?>
    
    

    10.2.2 Python

    #!/usr/bin/python
    # -*- coding: utf-8 -*-
    
    import requests, json
    
    api_url = "https://simple-api.dondominio.net"
    api_user = "XXXXXXX"
    api_pass = "YYYYYYY"
    api_port = "443"
    
    def ddapi_query(query, data={}):
        data.update({"apiuser": api_user, "apipasswd": api_pass})
        try:
            url = api_url + ":" + api_port + "/" + query.strip("/") + "/"
            return requests.post(url, data, verify=True).json()
        except requests.exceptions.RequestException as e:
            print str(e)
            return None
    
    
    if __name__ == "__main__":
        response = ddapi_query("/tool/idnconverter/", {"query": "España"})
        if isinstance(response, dict):
            print "SUCCESS: " + "YES" if response["success"] else "NO"
            if response["success"]:
                print "PunyCode: " + response["responseData"]["punycode"]
    
    
    

    10.2.3 Java

    import java.io.BufferedReader;
    import java.io.InputStreamReader;
    import java.util.HashMap;
    
    import org.apache.http.HttpEntity;
    import org.apache.http.client.methods.CloseableHttpResponse;
    import org.apache.http.client.methods.HttpPost;
    import org.apache.http.entity.mime.MultipartEntityBuilder;
    import org.apache.http.impl.client.CloseableHttpClient;
    import org.apache.http.impl.client.HttpClients;
    
    import org.json.simple.JSONObject;
    import org.json.simple.parser.JSONParser;
    
    
    public class DDClientExample {
        private static final String API_URL     = "https://simple-api.dondominio.net";
        private static final String API_USER    = "xxxxxx";
        private static final String API_PASS    = "yyyyyy";
        private static final String API_PORT    = "443";
    
        public static JSONObject ddapiQuery(
                String query,
                HashMap<String,
                String> data) throws Exception {
            JSONObject result = null;
            CloseableHttpClient httpclient = HttpClients.createDefault();
            try {       
                MultipartEntityBuilder entity = MultipartEntityBuilder.create();
                entity.addTextBody("apiuser", API_USER).
                    addTextBody("apipasswd", API_PASS);
                for (String key : data.keySet()) {
                    entity.addBinaryBody(key, data.get(key).getBytes("UTF-8"));
                }
                HttpEntity post = entity.build();
    
                HttpPost httppost = new HttpPost(API_URL + ":" + API_PORT + query);
                httppost.setEntity(post);
                CloseableHttpResponse response = httpclient.execute(httppost);
                try {
                    BufferedReader rd = new BufferedReader(
                            new InputStreamReader(response.getEntity().getContent())
                            );
                    StringBuffer buffer = new StringBuffer();
                    String line = "";
                    while ((line = rd.readLine()) != null) {
                        buffer.append(line);
                    }
                    result = (JSONObject) new JSONParser().parse(buffer.toString());
                } finally {
                    response.close();
                }
            } finally {         
                httpclient.close();
            }
    
            return result;
        }
    
        public static void main(String[] args) {
            try {
                HashMap<String, String> data = new HashMap<String, String>();
                data.put("query", "España");
                JSONObject result = ddapiQuery("/tool/idnconverter/", data);
                if (!(boolean) result.get("success")) {
                    throw new Exception("SUCCESS: NO");
                }
    
                JSONObject responseData = (JSONObject) new JSONParser().parse(
                        result.get("responseData").toString()
                        );
                System.out.println("SUCCESS: YES");
                System.out.println("PunyCode: " + responseData.get("punycode"));
            } catch (Exception e) {
                System.out.println(e.getMessage());
            }
        }
    }
    
    

    10.2.4 Perl

    #!/usr/bin/perl
    use strict;
    use warnings;
    
    use LWP;
    use JSON;
    
    my $api_url = "https://simple-api.dondominio.net";
    my $api_port = "443";
    my $api_user = "XXXXXXX";
    my $api_pass = "YYYYYYY";
    
    sub ddapi_query {
        my $query = shift;
        my $data = shift;
    
        $data->{ "apiuser" } = $api_user;
        $data->{ "apipasswd" } = $api_pass;
    
        my $browser = LWP::UserAgent->new;
        my $request = $browser->post(
            $api_url.':'.$api_port.$query,
            $data
        );
        if (!$request->is_success) {
            return 0;
        }
        print $request->content;
        return JSON->new->utf8->decode($request->content);
    }
    
    # Query Example:
    my $queryData = { query => 'España' };
    my $response = ddapi_query("/tool/idnconverter/", $queryData );
    if (!$response || !$response->{'success'}) {
        die "SUCCESS: NO\n";
    }
    
    print "SUCCESS: SI\n";
    print 'PunyCode: ' . $response->{'responseData'}->{'punycode'} . "\n";
    exit 0
    
    

    10.2.5 Bash/Wget

    #!/bin/bash
    
    URI="https://simple-api.dondominio.net"
    Credentials="&apiuser=XXXXXX&apipasswd=YYYYYY";
    
    function DDAPI_Query
    {
       query="$1";
       postdata="${Credentials}${2}";
       /usr/bin/wget -q -O - --post-data="$postdata" "${URI}${query}"
    }
    
    
    response=$(DDAPI_Query "/tool/idnconverter/" "query=españa.com");
    echo $response;
    exit 0;
    
    

    10.3 ChangeLog

    Puedes ver el historial de cambios en el ChangeLog