API de DonDominio

    API DonDominio

    Manual de usuario de la API
    Versión 1.0.4 - 07/12/2016
    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.4",
        "responseData": {
            "ip": "127.0.0.1",
            "lang": "en",
            "version": "1.0.4"
        }
    }

    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.4",
        "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 Optional json Formato de la respuesta.
    Valores posibles: json, xml
    output-pretty Optional 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.4","responseData":{"ip":"37.152.93.46","lang":"en","version":"1.0.4"}}

    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.4</version><responseData><ip>37.152.93.46</ip><lang>en</lang><version>1.0.4</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.4</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

    3 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/csrdecode/ Requeridas Decodificar un CSR
    /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.4",
        "responseData": {
            "ip": "127.0.0.1",
            "lang": "en",
            "version": "1.0.4"
        }
    }

    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 Required 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.4",
        "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,tv,es TLDs donde buscar las sugerencias. Deben estar separados por comas.
    TLDs disponibles: com,net,tv,cc,es,org,info,biz,eu

    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.4",
        "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 Required 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.4",
        "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.4",
        "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 CSR Decode ( tool/csrdecode/ )

    Uso: Decodificar los parámetros de un CSR.

    Petición:

    POST /tool/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 Required Datos del código CSR (incluyendo las lineas ---BEGIN--- y ---END--

    Descripción de los campos de respuesta:

    Campo Descripción
    csrData Código CSR enviado

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "tool\/csrdecode",
        "version": "1.0.4",
        "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"
        }
    
    }

    3.6 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 Required Dominio/consulta
    type Reqired Tipo de consulta. Valores posibles: A, AAAA, ANY, CNAME, MX, NS, SOA, TXT
    nameserver Required 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.4",
        "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.7 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 Required Nombre de dominio
    nameservers Required 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.4",
        "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 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/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.4",
        "responseData": {
            "clientName": "clientX",
            "apiuser": "YOURAPIUSER",
            "balance": 124.0,
            "threshold": 30.0,
            "currency": "EUR",
            "ip": "127.0.0.1"
        }
    }

    4.2 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 Optional Filtra por el TLD
    tldtop Optional 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/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/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

    Ejemplo de respuesta:

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

    5 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/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

    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 Required 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.4",
        "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 Required 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.4",
        "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 Required Nombre del dominio
    period Optional 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 Optional false Debe ser premium = true para registrar dominios premium
    nameservers Optional 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] Required Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] Optional Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] Optional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] Optional 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 Required 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 Required Tipo de contacto individual o organization
    ownerContactFirstName Required Nombre del contacto
    ownerContactLastName Required Apellidos del contacto
    ownerContactOrgName Required
    if ownerContactType = organization
    Nombre de la empresa
    ownerContactOrgType Required
    if ownerContactType = organization
    y ownerCountry = ES
    Tipo de organización española (Ver tabla)
    ownerContactIdentNumber Required Número de identificación fiscal, VAT Number, etc...
    ownerContactEmail Required Correo electrónico del contacto
    ownerContactPhone Required Número de teléfono del contacto en formato +DD.DDDDDDDD
    ownerContactFax Optional Número de fax en formato +DD.DDDDDDDDD
    ownerContactAddress Required Dirección del contacto
    ownerContactPostalCode Required Código Postal del contacto
    ownerContactCity Required Ciudad/Localidad del contacto
    ownerContactState Required Estado/Provincia del contacto
    ownerContactCountry Required (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

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/create",
        "version": "1.0.4",
        "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 Required ENS Identifier. Más información en ENS Aero ID
    aeroPass Required ENS Password
    Dominios .barcelona, .cat, .pl, .scot, .eus, .gal, .quebec

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    domainIntendedUse Required Intención de uso del dominio
    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 Optional 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 Optional 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 Required
    if ownerContactType = individual
    Fecha de nacimiento del titular
    Dominios .it

    Parámetros de la petición:

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

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    lawaccid Required Número de acreditación del solicitante
    lawaccbody Required Nombre oficial del regulador
    lawaccyear Required Año de la acreditación
    lawaccjurcc Required País de la jurisdicción de la acreditación
    lawaccjurst Required 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 Optional false (bool) Flag que indica si el contacto titular es miembro asociado del SHRM
    jobsOwnerWebsite Required Website del contacto titular
    jobsOwnerTitle Optional Titulo del contacto titular
    jobsOwnerIndustrytype Optional Tipo de comercio del contacto titular
    jobsAdminIsAssocMember Optional false (bool) Flag que indica si el contacto administrivo es miembro asociado del SHRM
    jobsAdminWebsite Required Website del contacto administrativo
    jobsAdminTitle Optional Titulo del contacto administrativo
    jobsAdminIndustrytype Optional Tipo de comercio del contacto administrativo
    jobsTechIsAssocMember Optional false (bool) Flag que indica si el contacto técnico es miembro asociado del SHRM
    jobsTechWebsite Required Website del contacto técnico
    jobsTechTitle Optional Titulo del contacto técnico
    jobsTechIndustrytype Optional Tipo de comercio del contacto técnico
    jobsBillingIsAssocMember Optional false (bool) Flag que indica si el contacto de facturación es miembro asociado del SHRM
    jobsBillingWebsite Required Website del contacto de facturación
    jobsBillingTitle Optional Titulo del contacto de facturación
    jobsBillingIndustrytype Optional 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 Required 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 Optional Autoridad que certifica la profesión del titular
    ltdaLicenseNumber Optional Número de licencia del titular
    Dominios .moscow

    Parámetros de la petición:

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

    Parámetros de la petición:

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

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    travelUIN Required Número UIN que proporciona www.travel.travel
    Dominios .xxx

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    xxxClass Required 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 Required
    if xxxClass = default
    Nombre y apellidos para el registro en la comunidad .XXX
    xxxEmail Required
    if xxxClass = default
    Correo electrónico para el registro en la comunidad .XXX
    xxxId Required
    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 Required Nombre del dominio
    nameservers Optional 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 Optional El authcode del dominio en caso necesario.
    ownerContact[Data] Required Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] Optional Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] Optional Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] Optional 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

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/create",
        "version": "1.0.4",
        "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 Optional false (bool) Flag que indica si el contacto titular es miembro asociado del SHRM
    jobsOwnerWebsite Required Website del contacto titular
    jobsOwnerTitle Optional Titulo del contacto titular
    jobsOwnerIndustrytype Optional Tipo de comercio del contacto titular
    jobsAdminIsAssocMember Optional false (bool) Flag que indica si el contacto administrivo es miembro asociado del SHRM
    jobsAdminWebsite Required Website del contacto administrativo
    jobsAdminTitle Optional Titulo del contacto administrativo
    jobsAdminIndustrytype Optional Tipo de comercio del contacto administrativo
    jobsTechIsAssocMember Optional false (bool) Flag que indica si el contacto técnico es miembro asociado del SHRM
    jobsTechWebsite Required Website del contacto técnico
    jobsTechTitle Optional Titulo del contacto técnico
    jobsTechIndustrytype Optional Tipo de comercio del contacto técnico
    jobsBillingIsAssocMember Optional false (bool) Flag que indica si el contacto de facturación es miembro asociado del SHRM
    jobsBillingWebsite Required Website del contacto de facturación
    jobsBillingTitle Optional Titulo del contacto de facturación
    jobsBillingIndustrytype Optional Tipo de comercio del contacto de facturación
    Dominios .ru

    Parámetros de la petición:

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

    Parámetros de la petición:

    Nombre Obligatoriedad Valor por defecto Descripción
    travelUIN Required Número UIN que proporciona www.travel.travel

    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
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Requerido
    (unless the field domain is specified)
    Identificador del dominio
    authcode Optional El authcode del dominio en caso necesario.

    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.4",
        "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
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Requerido
    (unless the field domain is specified)
    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
    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 = 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.4",
        "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
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Requerido
    (unless the field domain is specified)
    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.4",
        "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
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Requerido
    (unless the field domain is specified)
    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.4",
        "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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    Identificador del dominio
    name Required Nombre del servidor DNS asociado al dominio
    ipv4 Required IPv4
    ipv6 Optional 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.4",
        "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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    Identificador del dominio
    name Required Nombre del servidor DNS asociado al dominio
    ipv4 Required IPv4
    ipv6 Optional 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.4",
        "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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    Identificador del dominio
    name Required 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.4",
        "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.4",
        "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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    Identificador del dominio
    infoType Optional 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

    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)
    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)
    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

    Ejemplo de infoType = status

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/getinfo",
        "version": "1.0.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    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.4",
        "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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    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.4",
        "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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    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.4",
        "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 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 Required
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Required
    (unless the field domain is specified)
    Identificador del dominio
    curExpDate Required Fecha actual de expiración en formato YYYYMMDD o YYYY-MM-DD
    period Optional 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

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "domain\/renew",
        "version": "1.0.4",
        "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.18 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 Required 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.4",
        "responseData": {
            "domain": "example1.com",
            "whoisData": "Domain Name: EXAMPLE1.COM\nRegistry Domain ID... whois data..."
        }
    }

    5.19 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
    (unless the field domainID is specified)
    Nombre del dominio
    domainID Requerido
    (unless the field domain is specified)
    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.4",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "name": "example-domain.tv",
            "status": "active",
            "tld": "tv",
            "tsExpir": "2015-05-14",
            "domainID": 60523498
        }
    }

    5.20 Tablas asociadas

    5.20.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.20.2 Modos de renovación

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

    5.21 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.22 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.22.1 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.22.2 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 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/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 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 Optional Cadena a buscar en el nombre/organización
    email Optional Filtro por correo electrónico
    country Optional Filtro por código de país
    identNumber Optional Filtro por identificacion
    verificationstatus Optional Filtro del estado de la verificación
    daaccepted Optional (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.4",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 14,
                "total": 14
            },
            "contacts": [
                {
                    "contactID": "CTS-378084",
                    "contactType": "organization",
                    "contactName": "Clark Tech S.L",
                    "identNumber": "XSS2342342-3",
                    "email": "tech-email@example.com",
                    "country": "ES",
                         "verificationstatus": "verified",
                         "daaccepted": true
                },
                {
                    "contactID": "JS-199180",
                    "contactType": "individual",
                    "contactName": "John Smith",
                    "identNumber": "4-8-15-16-23-42",
                    "email": "johnsmith@example.xv",
                    "country": "US"
                         "verificationstatus": "inprocess"
                         "daaccepted": false
                }
                /*
                ,{ ....  }
                */
                ]
        }
    }

    6.2 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 Required Identificador del contacto
    infoType Optional 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.4",
        "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.3 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.4",
        "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 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 Optional Nombre del servicio/alojamiento exacto a filtrar
    word Optional Cadena (substring) para filtrar en la lista de servicios asociados
    tld Optional Cadena para filtrar por el TLD del servicio
    renewable Optional (Bool) Filtrar por la lista de servicios en periodo de renovación o no
    status Optional 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.4",
        "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 Required Nombre del servicio
    infoType Optional 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

    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/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 = 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

    Ejemplo de infoType= status

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.4",
        "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.4",
        "responseData": {
            "name": "example-test01.com",
            "type": "Basic Hosting Service",
            "status": "active",
            "tsExpir": "2015-12-10",
            "resources": {
                "ftpusage": {
                    "value": 11534336,
                    "max": 1038336000,
                    "unit": "bytes"
                },
                "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 = serverinfo

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/getinfo",
        "version": "1.0.4",
        "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"
            }
        }
    }

    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.4",
        "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.4",
        "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.4",
        "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 Required Nombre del servicio
    updateType Requerido Tipo de información a actualizar
    renewalMode: Cambio en el modo de renovación
    updateType = renewalMode
    renewalMode Requerido Modo de renovación (Ver tabla)

    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

    Ejemplo de respuesta:

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

    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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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 Optional 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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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 Required Nombre del servicio/alojamiento
    filter Optional 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

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/subdomainlist",
        "version": "1.0.4",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 2,
                "total": 2
            },
            "subdomain": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test.example-test01.com",
                    "ftpPath": "public-test\/"
                },
                {
                    "entityID": "SRV0000214277-000396073",
                    "name": "www.example-test01.com",
                    "ftpPath": "public\/"
                }
                /*
                ,{ ....  }
                */
            ]
        }
    }

    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.4",
        "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

    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\/subdomaincreate",
        "version": "1.0.4",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "subdomain": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test.example-test01.com",
                    "ftpPath": "public-test\/"
                }
            ]
        }
    }

    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

    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\/subdomainupdate",
        "version": "1.0.4",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
            "subdomain": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "test.example-test01.com",
                    "ftpPath": "public-test\/"
                }
            ]
        }
    }

    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.4",
        "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 Required Nombre del servicio/alojamiento
    filter Optional 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.4",
        "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.4",
        "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.4",
        "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 Required 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.4",
        "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.4",
        "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 Required Nombre del servicio/alojamiento
    filter Optional 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

    Ejemplo de respuesta:

    {
        "success": true,
        "errorCode": 0,
        "errorCodeMsg": "",
        "action": "service\/maillist",
        "version": "1.0.4",
        "responseData": {
            "queryInfo": {
                "page": 1,
                "pageLength": 1000,
                "results": 2,
                "total": 2
            },
            "mail": [
                {
                    "entityID": "SRV0000214277-000396072",
                    "name": "hola@example123.com",
                    "password": "############"
                },
                {
                    "entityID": "SRV0000214277-000396073",
                    "name": "test2@example123.com",
                    "password": "############"
                }
    
                /*
                ,{ ....  }
                */
            ]
        }
    }

    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

    Ejemplo de respuesta:

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

    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

    Ejemplo de respuesta:

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

    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

    Ejemplo de respuesta:

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

    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.4",
        "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 Required Nombre del servicio/alojamiento
    filter Optional 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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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 Required Nombre del servicio/alojamiento
    filter Optional Filtro
    filterType Optional Filtro por tipo
    filterValue Optional 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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "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.4",
        "messages": [
            "Operation done correctly."
        ],
        "responseData": {
        }
    }

    7.48 Tablas 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
    basic Alojamiento Básico
    professional Alojamiento Profesional
    advanced Alojamiento Avanzado

    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 Value Format
    A Address IPv4
    AAAA Address IPv6 IPv6
    CNAME Canonical Name Hostname
    MX Mail Exchange Mail Server Hostname
    SRV Service Format weight port destiny-host
    TXT Text Texto
    NS NameServer DNS Server HostName

    8 Anexo I

    8.1 Tablas

    8.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
    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
    10001 Error de Webconstructor

    8.1.2 Country codes

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

    8.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.

    8.2 Ejemplos

    8.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";
        }
    }
    ?>
    

    8.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"]
    

    8.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());
            }
        }
    }
    

    8.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
    

    8.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;
    

    8.3 ChangeLog

    Puedes ver el historial de cambios en el ChangeLog