API de DonDominio

    SDK de DonDominio para PHP

    Manual de usuario del SDK de DonDominio para PHP
    DonDominio

    Descargar desde Github

    1 Introducción

    Este es el manual de usuario para el SDK de DonDominio para PHP.

    El SDK de DonDominio para PHP permite crear aplicaciones personalizadas que usen la API de DonDominio de forma sencilla bajo PHP5. Incluye soporte para todas las acciones de la API de DonDominio y se actualiza de forma regular para incorporar todos los cambios que se introduzcan en la misma.

    1.1 Consideraciones previas

    El SDK de DonDominio permite usar la API de DonDominio en tus aplicaciones. Para poder acceder a la API, es necesario disponer de una cuenta de API activa.

    Consulta la la documentación correspondiente de la API de DonDominio para más información.

    1.2 Límites

    Por favor, antes de usar el SDK de DonDominio o la API de DonDominio, lee las Políticas de uso.

    2  Instalación

    Existen dos métodos para instalar el SDK en tu aplicación.

    2.1 Composer

    Usar Composer es la manera más rápida y sencilla de instalar el SDK. Edita (o crea) tu fichero composer.json y añade el SDK en tu sección require:

    {
        "require": {
            "dondominio/api-sdk-php": "@stable"
        }
    }

    Luego, ejecuta composer install o composer update para descargar e instalar la librería.

    2.2 Instalación manual

    Otra opción es descargar el código fuente en un fichero ZIP desde nuestro repositorio de Github, copiarlo a una carpeta de tu aplicación e incluir el fichero DonDominioAPI.php:

    require_once("/path/to/lib/DonDominioAPI.php");

    3 Uso

    Existen dos formas de usar el SDK de DonDominio. Una vez instalado e incluído el fichero DonDominioAPI.php pueden usarse cualquiera de las dos.

    3.1 Uso básico

    Este es el método recomendado para usar el SDK. La clase DonDominio provee wrappers para todas las acciones de la API de DonDominio sin tener que hacer nada más.

    Por ejemplo, para obtener la información de la cuenta de usuario de DonDominio:

    require_once("/path/to/lib/src/autoloader.php");
    
    $dondominio = new \Dondominio\API\API([
        'apiuser' => YOUR_API_USER,
        'apipasswd' => YOUR_API_PASSWORD
    ]);
    
    $response = $dondominio->account_info();
    
    print_r( $response->getResponseData());

    3.2 Uso avanzado

    También puedes usar la clase \Dondominio\API\API para hacer llamadas a la API de forma manual. Este método requiere procesar las peticiones y las respuestas de forma manual.

    Por ejemplo, el ejemplo anterior podría realizarse así:

    require_once("/path/to/lib/src/autoloader.php");
    
    $dondominio = new \Dondominio\API\API([
        'apiuser' => YOUR_API_USER,
        'apipasswd' => YOUR_API_PASSWORD
    ]);
    
    $data = $dondominio->call( 'account/info/', []);
    
    $response = json_decode( $data, true );
    
    print_r( $response['responseData'] );

    El resultado de ambos bloques de código será el mismo.

    El método avanzado no se cubre en este manual. Para usarlo, debes usar las URIs definidas en la documentación de la API de DonDominio de la misma forma anteriormente descrita, adjuntando en el segundo parámetro de la llamada a call los argumentos definidos en la documentación. La respuesta será una cadena JSON válida que podrás decodificar usando json_decode u otros métodos que prefieras.

    3.3 Probando el SDK

    El SDK incluye un método llamado info que permite comprobar la configuración del mismo y buscar requisitos no cumplidos (como las librerías cURL y JSON de PHP). Un archivo llamado config-check.php se incluye en el paquete básico del SDK en Github. Edita este archivo con tu usuario y contraseña de API y ábrelo desde tu navegador web o línea de comandos para comprobar los requisitos en tu sistema y que la configuración sea válida.

    4 Módulo: Tool

    El módulo Tool provee herramientas de uso general.

    Todos los métodos de este módulo están prefijados con tool_.


    4.1 tool_hello()

    Comprueba que la API está disponible y se puede acceder a ella.

    Petición:

    $response = $dondominio->tool_hello();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    None

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ip string La IP desde la que se accede a la API
    lang string El idioma que está usando la API
    version string La versión actual de la API

    4.2 tool_idnConverter()

    Convierte un nombre de dominio de Unicode a Punycode (formato IDNA) y viceversa.

    Petición:

    $response = $dondominio->tool_idnConverter( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    query string Nombre de dominio a convertir

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    query string La petición original
    unicode string El nombre de dominio en formato Unicode
    punycode string El nombre de dominio en formato Punycode

    4.3 tool_domainSuggests()

    version >= 1.3
    Sugiere dominios disponibles basados en una palabra o texto.

    Petición:

    $response = $dondominio->tool_domainSuggests( array(
        'query' => 'example',
        'language' => 'en,es,fr,de,pt',
        'tlds' => 'com,net,tv,cc'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    query string Yes Texto a buscar
    language string No es Idiomas para las sugerencias. Uno o varios (separados por coma) entre: es, en, zh, fr, de, kr, pt, tr
    tlds string No com,net TLDs de los que sugerir dominios. Uno o varios (separados por coma) entre: com,net,tv,cc

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    suggests Array Sugerencias
    suggests/word Array Sugerencias para word
    suggests/word/tld boolean Indica si word.tld está disponible o no

    4.4 tool_getTable()

    Obtiene diferentes tablas de códigos que pueden ser usadas en otras llamadas a la API de DonDominio, como por ejemplo, los códigos de paises permitidos.

    Petición:

    $response = $dondominio->tool_getTable( 'countries' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    tableType string Nombre de la tabla a obtener:
    countries: Lista de códigos de 2 caracteres de paises.
    es_juridic: Lista de tipos jurídicos usados por el gobierno de España.

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    items array Un array que contiene la información de la tabla

    Más información
    Consulta la sección de la API correspondiente para más información.


    4.5 tool_dig()

    Comprueba el estado de los servidores DNS asociados a un dominio.

    Petición:

    $response = $dondominio->tool_dig( array(
        'query' => 'example.com',
        'type' => 'SOA',
        'nameserver' => '8.8.8.8'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    query string Nombre de dominio a comprobar
    type string Tipo de consulta a realizar. Puede ser A, AAAA, ANY, CNAME, MX, NS, SOA, TXT o CAA.
    nameserver string Servidor DNS a usar en formato IPv4

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    domain string Nombre del dominio comprobado
    query string La petición realizada
    nameserver string Servidor DNS usado
    type string Tipo de consulta
    result string Resultado de la consulta en formato texto

    4.6 tool_zonecheck()

    Comprueba la zona de un dominio para asegurarse de que cumple unos requisitos mínimos.

    Petición:

    $response = $dondominio->tool_zonecheck(
        'example.com',
        array(
            'nameservers' => '8.8.8.8,8.8.4.4'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre de dominio
    nameservers string Lista de servidores DNS separados por comas (mínimo 2)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    domain string Nombre del dominio comprobado
    nameservers string Servidor DNS usado
    result string Resultado de la consulta
    result/zonepass boolean true si cumple las condiciones del TLD
    result/report string Información completa de comprobación

    5 Módulo: Account

    El módulo Account permite consultar información sobre la cuenta de usuario actualmente usando la API de DonDominio.

    Todos los métodos de este módulo están prefijados con account_.


    5.1 account_info()

    Obtiene información general sobre la cuenta de usuario.

    Petición:

    $response = $dondominio->account_info();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    Ninguno        

    Respuesta

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    clientName string Nombre del cliente
    apiuser string Nombre de usuario de la API
    balance float Saldo en cuenta disponible
    threshold float Saldo a partir del cual se notifica por saldo bajo
    currency string Moneda usada para el saldo
    ip string Dirección IP usada para conectar a la API

    5.2 account_promos()

    Listado de las actuales promociones.

    Petición:

    $response = $dondominio->account_promos();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción

    Descripción de los campos de respuesta:

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

    5.3 account_zones()

    Obtiene una lista de TLDs disponibles y las tarifas asociadas a cada uno de ellos.

    Petición:

    $response = $dondominio->account_zones( array(
        'pageLength' => 100,
        'page' => 1,
        'tld' => 'com',
        'tldtop' => 'es'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength integer No 100 Elementos por página
    page integer No 1 Página de resultados a obtener
    tld string No Filtrar por TLD (completo o parcial)
    tldtop string No Filtrar por TLD superior (completo o parcial)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo array Array con los datos de la consulta.
    queryInfo/page integer Página actual.
    queryInfo/pageLength integer Elementos por página.
    queryInfo/results integer Número de resultados obtenidos.
    queryInfo/total integer Total de resultados disponibles.
    zones array Array que contiene todas las zonas (TLDs) disponibles.
    zones/tld string Nombre del TLD.
    zones/tldtop string Nombre del TLD superior.
    zones/authcodereq boolean Indica si el TLD requiere un Authcode para las transferencias.
    zones/requirements string Si existe, indica los requisitos especiales del TLD.
    zones/create array Detalles de creación de TLD. Si no existe, el TLD no permite registro.
    zones/create/price float Precio de registro.
    zones/create/years string Periodos, en años, que se permiten registrar.
    zones/create/inPromo bool Indica si el TLD dispone de una promo
    Sólo cuando es true
    zones/renew array Detalles de renovación de TLD. Si no existe, el TLD no permite renovaciones.
    zones/renew/price float Precio de renovación.
    zones/renew/years string Periodos, en años, que se permiten renovar.
    zones/renew/inPromo bool Indica si el TLD dispone de una promo
    Sólo cuando es true
    zones/transfer array Detalles de transferencia de TLD. Si no existe, el TLD no permite la transferencia.
    zones/transfer/price float Precio de transferencia.
    zones/transfer/years string Periodos, en años, que se permiten transferir.
    zones/transfer/inPromo bool Indica si el TLD dispone de una promo
    Sólo cuando es true

    6 Módulo: Domain

    El módulo Domain permite listar y gestionar dominios en DonDominio.

    Todos los métodos de este módulo están prefijados con domain_.


    6.1 domain_check()

    Permite comprobar si un dominio está disponible para registro.

    Petición:

    $response = $dondominio->domain_check( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio a comprobar

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre de dominio en formato Unicode
    punycode string Nombre de dominio en formato Punycode
    tld string TLD del dominio
    available boolean Si es true indica que está disponible para registro
    premium boolean Si es true indica que es un dominio premium
    price float Precio de registro del dominio
    currency string Moneda en que se expresa el precio

    6.2 domain_checkForTransfer()

    Permite comprobar si un dominio está disponible para ser transferido.

    Petición:

    $response = $dondominio->domain_checkForTransfer( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre de dominio a comprobar

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre de dominio en formato Unicode
    punycode string Nombre de dominio en formato Punycode
    tld string TLD del dominio
    transferavail boolean Si es true indica que está disponible para transferencia
    transfermsg string Mensajes adicionales en caso de que no pueda transferirse
    price float Precio de registro del dominio
    currency string Moneda en que se expresa el precio

    6.3 domain_create()

    Registra un nuevo dominio en DonDominio.

    Petición:

    $response = $dondominio->domain_create(
        'example.com',
        array(
            'period' => 1,
            'premium' => false,
            'nameservers' => '8.8.8.8,8.8.4.4',
            'ownerContactID' => 'XXX-00000'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio
    period integer No Mínimo de años según TLD (normalmente 1 año) Número de años de registro del dominios (por defecto el número mínimo de años)
    premium boolean No false Debe ser premium = true para registrar dominios premium
    nameservers string No 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] N/A Datos del contacto del titular (Ver siguiente tabla)
    adminContact[Data] N/A No Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] N/A No Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] N/A No Datos del contacto de facturación. Si no se especifica se aplicarán los mismos datos del contacto administrativo

    Descripción de los campos de respuesta:

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

    6.3.1 Definir 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:

    Parámetro Tipo Necesario Valor por defecto Descripción
    ownerContactID string 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:

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

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


    6.4 domain_transfer()

    Transfiere un dominio desde otro registrador hacia DonDominio.

    Petición:

    $response = $dondominio->domain_transfer(
        'example.com',
        array(
            'nameservers' => '8.8.8.8,8.8.4.4',
            'authcode' => 'aaaaaaaaaa',
            'ownerContactID' => 'XXX-00000'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio
    authcode string No Authcode (código EPP), si procede
    nameservers string No 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
    foacontact string No owner Contacto al que se envia el correo de FOA (Valores posibles owner o admin)
    ownerContact[Data] N/A Datos del contacto del titular
    adminContact[Data] N/A No Datos del contacto administrativo. Si no se especifica se se aplicarán los mismos datos del contacto titular
    techContact[Data] N/A No Datos del contacto técnico. Si no se especifica se aplicarán los mismos datos del contacto administrativo
    billingContact[Data] N/A No Datos del contacto de facturación. Si no se especifica se aplicarán los mismos datos del contacto administrativo

    Descripción de los campos de respuesta:

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

    6.5 domain_transferRestart()

    Reinicia el proceso de transferencia de un dominio.

    Petición:

    $response = $dondominio->domain_transferRestart(
        'example.com',
        array(
            'authcode' => 'XXXXX'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    authcode string No Nuevo authcode
    foacontact string No owner Contacto al que se envia el correo de FOA (Valores posibles owner o admin)

    Descripción de los campos de respuesta:

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

    6.6 domain_update()

    Actualiza los datos de un dominio.

    Petición:

    $response = $dondominio->domain_update(
        'example.com',
        array(
            'updateType' => 'contact',
            'ownerContactID' => 'XXX-00000'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    updateType string Tipo de información a actualizar
    contact: Modificación de contatos
    nameservers: Modificación de los servidores DNS
    transferBlock: Activación/Desactivación del bloqueo de transferencia
    block: Activación/Desactivación del bloqueo de modificaciones
    whoisPrivacy: Activación/Desactivación del servicio de WhoisPrivacy
    renewalMode: Cambio en el modo de renovación
    tag: Cambio de las etiquetas de un dominio
    viewWhois: Activación/Desactivación de la visualización de datos en el Whois
    updateType = contact
    ownerContact[Data] N/A No Datos de contacto propietario
    adminContact[Data] N/A No Datos de contacto administrativo
    techContact[Data] N/A No Datos de contacto técnico
    billingContact[Data] N/A No Datos de contacto de pago
    updateType = nameservers
    nameservers string 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 boolean false Nuevo estado del bloqueo de transferencia
    updateType = block
    block boolean false Nuevo estado del bloqueo
    updateType = whoisPrivacy
    whoisPrivacy boolean false Nuevo estado del servicio de Whois Privacy
    updateType = viewWhois
    viewWhois boolean false Nuevo estado de la visualización del Whois público
    updateType = renewalMode
    renewalMode string Modo de renovación (ver tabla)
    updateType = tag
    tag array Etiquetas del dominio

    Descripción de los campos de respuesta:

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

    6.7 domain_updateNameServers()

    Modifica los servidores DNS de un dominio. Equivale a usar domain_update() con updateType => 'nameservers'.

    Petición:

    $response = $dondominio->domain_updateNameServers(
        'example.com',
        array('8.8.8.8', '8.8.4.4')
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre de dominio o Domain ID
    nameservers array Array de string con los servidores DNS

    Descripción de los campos de respuesta:

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

    6.8 domain_updateContacts()

    Actualizar los contactos de un dominio. Equivale a usar domain_update() con updateType => 'contacts'.

    Petición:

    $response = $dondominio->domain_updateContacts(
        'example.com',
        array(
            'ownerContactID' => 'XXX-00000'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    ownerContact[Data] N/A No Datos de contacto propietario
    adminContact[Data] N/A No Datos de contacto administrativo
    techContact[Data] N/A No Datos de contacto técnico
    billingContact[Data] N/A No Datos de contacto de pago

    Descripción de los campos de respuesta:

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

    6.9 domain_glueRecordCreate()

    Crea un registro DNS asociado a un dominio (Gluerecord).

    Petición:

    $response = $dondominio->domain_glueRecordCreate(
        'example.com',
        array(
            'name' => 'test.example.com',
            'ipv4' => '212.20.40.200',
            'ipv6' => '2e02:2670:3:0:21a:4aff:fe24:c49f'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    name string Nombre del servidor DNS/gluerecord
    ipv4 string Dirección IPv4 del servidor DNS/gluerecord
    ipv6 string No Dirección IPv6 del servidor DNS/gluerecord

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio
    gluerecords array Información sobre servidores DNS/gluerecords del dominio
    gluerecords/name string Nombre del servidor DNS/gluerecord
    gluerecords/ipv4 string Dirección IPv4 del servidor DNS/gluerecord
    gluerecords/ipv6 string Dirección IPv6 del servidor DNS/gluerecord

    6.10 domain_glueRecordUpdate()

    Actualiza los datos de un registro DNS del dominio (gluerecord).

    Petición:

    $response = $dondominio->domain_glueRecordUpdate(
        'example.com',
        array(
            'name' => 'test.example.com',
            'ipv4' => '212.20.40.200',
            'ipv6' => '2e02:2670:3:0:21a:4aff:fe24:c49f'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    name string Nombre del servidor DNS/gluerecord
    ipv4 string Dirección IPv4 del servidor DNS/gluerecord
    ipv6 string No Dirección IPv6 del servidor DNS/gluerecord

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio
    gluerecords array Información sobre servidores DNS/gluerecords del dominio
    gluerecords/name string Nombre del servidor DNS/gluerecord
    gluerecords/ipv4 string Dirección IPv4 del servidor DNS/gluerecord
    gluerecords/ipv6 string Dirección IPv6 del servidor DNS/gluerecord

    6.11 domain_glueRecordDelete()

    Elimina un registro DNS asociado a un dominio (Gluerecord).

    Petición:

    $response = $dondominio->domain_glueRecordDelete(
        'example.com',
        array(
            'name' => 'test.example.com'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    name string Nombre del servidor DNS/gluerecord a eliminar

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio
    gluerecords array Información sobre servidores DNS/gluerecords del dominio
    gluerecords/name string Nombre del servidor DNS/gluerecord
    gluerecords/ipv4 string Dirección IPv4 del servidor DNS/gluerecord
    gluerecords/ipv6 string Dirección IPv6 del servidor DNS/gluerecord

    6.12 domain_getList()

    Realiza un listado/búsqueda de los dominios en tu cuenta

    Petición:

    $response = $dondominio->domain_getList();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados
    domain string No Dominio exacto a filtrar
    word string No Cadena para filtrar en la lista de dominios
    tld string No Cadena para filtrar por el TLD del dominio
    renewable boolean No Filtrar por la lista de dominios en periodo de renovación o no
    infoType string No 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 string No Identificador del contacto titular
    tag string No Filtro por etiqueta del dominio
    status string No Filtro por el estado del dominio. Ver tabla asociada
    ownerverification string No Filtro del estado de verificación de los datos del contacto titular

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    domains array Lista de dominios obtenidos en la consulta
    domains/name string Nombre del dominio
    domains/status string Estado del dominio
    domains/tld string TLD del dominio
    domains/tsExpir string Fecha de expiración del dominio
    domains/domainID string Identificador del dominio

    6.13 domain_getInfo()

    Obtiene la información sobre un dominio registrado en la cuenta de DonDominio.

    Petición:

    $response = $dondominio->domain_getInfo(
        'example.com',
        array(
            'infoType' => 'status'
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    infoType string Tipo de información a obtener
    status: Datos generales del dominio
    contact: Datos de los contactos (whois data)
    nameservers: Servidores DNS del dominio
    authcode: Authcode o código EPP
    service: Datos del servicio o alojamiento asociado
    gluerecords: Gluerecords asociados al dominio

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio (Domain ID)
    infoType = status
    tsCreate string Fecha de creación
    renewable boolean Indica si el dominio se puede renovar
    modifyBlock boolean Indica si el dominio tiene el bloque de modificaciones activo
    transferBlock boolean Indica si el dominio tiene las transferencias bloqueadas
    whoisPrivacy boolean Indica si el dominio tiene la privacidad de Whois activada
    authcodeCheck boolean Indica si se puede obtener el authcode con infoType = authcode
    serviceAssociated boolean Indica si el dominio tiene servicios asociados
    tag string Etiqueta del dominio
    infoType = contact
    contactOwner N/A Datos del propietario. Ver Datos de contactos.
    contactAdmin N/A Datos del contacto administrativo. Ver Datos de contactos.
    contactTech N/A Datos del contacto técnico. Ver Datos de contactos.
    contactBilling N/A Datos del contacto de pago. Ver Datos de contactos.
    infoType = nameservers
    nameservers N/A Servidores DNS. Ver [Servidores DNS][DNS Servers].
    infoType = authcode
    authcode string Authcode (código EPP) del dominio
    infoType = service
    service array Múltiples arrays (uno por servicio) conteniendo la información de los servicios asociados al dominio
    service/type string Tipo de servicio
    service/status string Estado del servicio
    service/tsExpir string Fecha de expiración
    infoType = gluerecords
    gluerecords array Múltiples arrays (uno por gluerecord) conteniendo la información de los gluerecords del dominio
    gluerecords/name string Nombre del gluerecord
    gluerecords/ipv4 string Dirección IPv4 del servidor NS/Gluerecord
    gluerecords/ipv6 string Direcciób IPv6 del servidor NS/Gluerecord

    6.14 domain_getAuthCode()

    Obtiene el authcode (o código EPP) de un dominio. Equivalente a usar domain_getInfo() con infoType = authcode.

    Petición:

    $response = $dondominio->domain_getAuthCode( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio (Domain ID)
    authcode string Authcode (código EPP) del dominio

    6.15 domain_getNameServers()

    Obtiene los servidores DNS asociados a un dominio. Equivalente a llamar a domain_getInfo() con infoType = nameservers.

    Petición:

    $response = $dondominio->domain_getNameServers( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio (Domain ID)
    defaultNS boolean Booleano que indica si tiene los servidores DNS por defecto del servicio asociado
    nameservers N/A Servidores DNS. Ver [Servidores DNS][DNS Servers]

    6.16 domain_getGlueRecords()

    Obtiene los servidores NS (Gluerecords) de un dominio. Equivalente a llamar a domain_getInfo() con infoType = gluerecords.

    Petición:

    $response = $dondominio->domain_getGlueRecords( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio (Domain ID)
    gluerecords array Múltiples arrays (uno por gluerecord) conteniendo la información de los gluerecords del dominio
    gluerecords/name string Nombre del gluerecord
    gluerecords/ipv4 string Dirección IPv4 del servidor NS/Gluerecord
    gluerecords/ipv6 string Dirección IPv6 del servidor NS/Gluerecord

    6.17 domain_getDnsSec()

    Obtener las entradas DNSSEC asociados a un dominio. Equivalente a llamar a domain_getInfo() con infoType = dnssec.

    Petición:

    $response = $dondominio->domain_getDnsSec( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

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

    6.18 domain_dnsSecCreate()

    Crear una entrada DNSSEC asociada a un dominio.

    Petición:

    $response = $dondominio->domain_dnsSecCreate( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    keytag string Keytag de la entrada DNSSEC
    algorithm string Algoritmo de la entrada DNSSEC
    digesttype string Tipo de digest de la entrada DNSSEC
    digest string Digest de la entrada DNSSEC

    Descripción de los campos de respuesta:

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

    6.19 domain_dnsSecDelete()

    Eliminar una entrada DNSSEC asociada a un dominio.

    Petición:

    $response = $dondominio->domain_dnsSecDelete( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    keytag string Keytag de la entrada DNSSEC
    algorithm string Algoritmo de la entrada DNSSEC
    digesttype string Tipo de digest de la entrada DNSSEC
    digest string Digest de la entrada DNSSEC

    Descripción de los campos de respuesta:

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

    6.20 domain_renew()

    Renueva un dominio existente en la cuenta de DonDominio.

    Petición:

    $response = $dondominio->domain_renew(
        'example.com',
        array(
            'curExpDate' => '2015-01-01',
            'period' => 1
        )
    );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    curExpDate string Fecha de expiración actual del dominio
    period integer Periodo de renovación

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    billing array Datos económicos de la operación
    billing/total float Coste total de la operación
    billing/currency string Moneda de la operacion
    domains array Datos del dominio registrado
    domains/name string Nombre del dominio
    domains/status string Estado del dominio
    domains/tld string TLD del dominio
    domains/tsExpir string Fecha de expiración del dominio
    domains/renewPeriod integer Periodo renovado
    domains/inPromo bool) Indica si el TLD dispone de una promo
    Sólo cuando es true

    6.21 domain_whois()

    Obtiene los datos del Whois público del dominio.

    Petición:

    $response = $dondominio->domain_whois( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Yes Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    domain string Nombre del dominio
    whoisData string Respuesta con los datos del Whois público

    6.22 domain_resendVerificationMail()

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

    Petición:

    $response = $dondominio->domain_resendVerificationMail( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

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

    6.23 domain_resendFOAMail()

    Reenvia el email de autorización del FOA al contacto titular.

    Petición:

    $response = $dondominio->domain_resendFOAMail( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Domain name
    status string Domain status
    tld string Domain TLD
    tsExpir string Domain expiration date
    domainID integer Domain identifier

    6.24 domain_resetFOA()

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

    Petición:

    $response = $dondominio->domain_resetFOA( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID

    Descripción de los campos de respuesta:

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

    6.25 domain_getHistory()

    Petición del historial del dominio

    Petición:

    $response = $dondominio->domain_getHistory( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain string Nombre del dominio o Domain ID
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del dominio
    status string Estado del dominio
    tld string TLD del dominio
    tsExpir string Fecha de expiración del dominio
    domainID string Identificador del dominio
    history/ts string History TimeStamp
    history/ip string IP Address
    history/title string Título
    history/message string Mensaje

    6.26 domain_listDeleted()

    Lista de dominios borrados

    Petición:

    $response = $dondominio->domain_listDeleted();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength integer No  1000 Results per page
    page integer No 1 Current page

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    domains array Lista de dominios obtenidos en la consulta
    domains/name string Nombre del dominio
    domains/tld string TLD del dominio
    domains/tsDeleted string Fecha de borrado del dominio
    domains/domainID string Identificador del dominio
    domains/info string Información

    6.27 Datos de contacto

    Todas las llamadas que devuelven datos de contactos lo hacen con los siguientes campos:

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    contactID string Identificador único de contacto
    contactType string Tipo de contacto
    individual: Persona física
    organization: Organización o empresa
    firstName string Nombre del contacto
    lastName string Apellidos del contacto
    orgName string Nombre de la organización o empresa
    orgType string country = ES, tipo de organización
    identNumber string NIF, CIF, VAT Number, Pasaporte u otro código de identificación de la persona u organización
    email string Correo electrónico
    phone string Teléfono de contacto (en formato +DD.DDDDDDD)
    fax string Fax de contacto (en formato +DD.DDDDDDDD)
    address string Dirección postal
    postalCode string Código postal
    city string Ciudad
    state string Estado o província
    country string Código de país
    verificationstatus string Estado de la verificación de los datos del contacto
    daaccepted boolean Flag que indica si el contacto tiene el Agente Designado (DA) aceptado
    esNicHandle string NIC Handle de los dominios .ES

    6.28 Datos de Nameservers

    Todas las llamadas que devuelven los datos de un Nameserver lo hacen con los siguientes campos:

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    order integer Número de orden del nameserver
    name string Nombre del servidor
    ipv4 string Dirección IPv4 del servidor

    7 Módulo: Contact

    El módulo Contact permite obtener los contactos almacenados en la cuenta de DonDominio y los detalles de cada uno de ellos.

    Todos los métodos de este módulo están prefijados con contact_.


    7.1 contact_create()

    Crea un contacto en la cuenta.

    Petición:

    $response = $dondominio->contact_create( [
                    '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',
                ] );

    Parámetros de la petición:

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

    Descripción de los campos de respuesta:

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

    7.2 contact_getList()

    Realiza un listado o búsqueda de contactos en la cuenta de DonDominio.

    Petición:

    $response = $dondominio->contact_getList();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength integer No 1000 Resultados máximos por página
    page integer No 1 Página de resultados a obtener
    name string No Cadena a buscar en nombre u organización
    email string No Filtrar por correo electrónico
    country string No Filtrar por código de país
    identNumber string No Filtrar por número de identificación
    verificationstatus string No Filtrar por estado de verificación del contacto. Uno de: verified, notapplicable, inprocess o failed
    daaccepted boolean No Filtrar por estado de aceptación de Agente Designado (DA)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo array Datos de la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Resultados obtenidos
    queryInfo/total integer Número total de resultados
    contacts array Datos de contactos recuperados (un array por elemento)
    contacts/contactID string Identificador único de contacto
    contacts/contactType string Tipo de contacto
    individual: Persona física
    organization: Organización o empresa
    contacts/contactName string Nombre del contacto
    contacts/email string Correo electrónico
    contacts/country string País

    7.3 contact_getInfo()

    Obtiene la información de un contacto almacenado en la cuenta de DonDominio.

    Petición:

    $response = $dondominio->contact_getInfo( 'XXX-00000' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    contactID string Identificador único del contacto
    infoType string No data Tipo de información a obtener
    data: Datos del contacto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    infoType = data
    contacto N/A Datos del contacto. Ver Datos de contactos.

    7.4 contact_resendVerificationMail()

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

    Petición:

    $response = $dondominio->contact_resendVerificationMail( 1234 );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    contactID string Si   Identificador del contacto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    contactID string Identificador del contacto
    contactType string Tipo de contacto:
    individual: Persona física
    organization: Organización / Empresa
    contactName string Nombre principal del contacto ( Organization Name o Individual Name)
    email string Correo electrónico
    country string Código de pais (Ver tabla)
    verificationstatus string Estado de la verificación de los datos del contacto (Ver tabla asociada)

    8 Módulo: Service

    version >= 1.3
    El módulo Service permite obtener información sobre los servicios asociados a la cuenta de usuario de DonDominio y realizar diferentes acciones sobre los mismos. También permite contratar nuevos servicios y asociarlos a la cuenta de usuario.

    Todos los métodos de este módulo están prefijados con service_.


    8.1 service_list()

    Realiza una búsqueda/listado de servicios en la cuenta.

    Petición:

    $response = $dondominio->service_list( array(
        'pageLength' => 1000,
        'page' => 1,
        'name' => 'example.com',
        'word' => 'example',
        'tld' => 'com',
        'renewable' => true,
        'status' => 'active'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength integer No  1000 Resultados por página 
    page integer No 1 Página de resultados
    name string No Nombre del servicio/alojamiento a buscar
    word string No Palabra clave a filtrar
    tld string No TLD a filtrar
    renewable boolean No Filtrar por servicios en periodo de renovación o no
    status string No Filtrar por estado del servicio/alojamiento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
    services Array Información sobre los servicios/alojamientos obtenidos
    services/name string Nombre del servicio
    services/status string Estado del servicio
    services/type string Tipo de servicio
    services/productKey string Código de tipo de servicio
    services/tsExpir string Fecha de expiración del servicio/alojamiento

    8.2 service_getInfo()

    Obtiene información sobre un servicio registrado en la cuenta de usuario.

    Petición:

    $response = $dondominio->service_getInfo( 'example.com', array(
        'infoType' => 'status'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    infoType string Tipo de información a obtener
    status: Datos generales del servicio/alojamiento
    resources: Información sobre los recursos disponibles del alojamiento
    serverinfo: Datos de servidores y paths asociados al servicio
    php: Información sobre la versión de PHP
    logerror: Lineas del log de errores del hosting

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    --------------------------
    name string Nombre del servicio/alojamiento
    status string Estado del servicio/alojamiento
    type string Tipo de servicio/alojamiento (ver tabla)
    tsExpir string Fecha de expiración del servicio/alojamiento
    infoType = status
    tsCreate string Fecha de creación del servicio/alojamiento
    renewable boolean Indica si el servicio/alojamiento puede ser renovado
    renewalMode string Modo de renovación del servicio/alojamiento (ver tabla)
    infoType = resources
    resources Array Información sobre recursos del servidor
    resources Array Información sobre el uso de FTP asociado al servicio/alojamiento
    resources/ftpusage/value integer Uso de FTP (almacenamiento)
    resources/ftpusage/max integer Almacenamiento máximo de FTP
    resources/ftpusage/unit string Unidad usada para medir el almacenamiento (bytes)
    resources/ftpfiles/value integer Número de archivos existentes
    resources/ftpfiles/max integer Número máximo de archivos permitidos
    resources/ftpfiles/unit string Unidad de archivos existentes (files)
    resources/webtraffic Array Datos sobre el tráfico web
    resources/webtraffic/value integer Tráfico web
    resources/webtraffic/max integer Tráfico web máximo
    resources/webtraffic/unit string Unidad usada para medir el tráfico web (bytes)
    resources/ftp Array Información sobre cuentas FTP asociadas al servicio/alojamiento
    resources/ftp/value integer Número de cuentas FTP
    resources/ftp/max integer Número máximo posible de cuentas FTP
    resources/ftp/unit string N/A
    resources/ddbb Array Información sobre las bases de datos asociadas al servicio/alojamiento
    resources/ddbb/value integer Número de bases de datos asociadas al servicio/alojamiento
    resources/ddbb/max integer Número máximo posible de cuentas de base de datos
    resources/ddbb/unit string N/A
    resources/ddbbusage Array Información sobre el uso de las bases de datos asociadas al servicio/alojamiento
    resources/ddbbusage/value integer Espacio utilizado por las bases de datos
    resources/ddbbusage/max integer Espacio máximo utilizable por las bases de datos
    resources/ddbbusage/unit string Unidad usada para medir el tamaño de las bases de datos (bytes)
    resources/subdomain Array Información sobre subdominios asociados al servicio/alojamiento
    resources/subdomain/value integer Número de subdominios actuales creados
    resources/subdomain/max integer Número máximo posible de subdominios
    resources/subdomain/unit string N/A
    resources/email Array Información sobre cuentas de correo asociadas al servicio/alojamiento
    resources/email/value integer Número de cuentas de correo actuales
    resources/email/max integer Número máximo de cuentas de correo posibles
    resources/email/unit string N/A
    resources/emailalias Array Información sobre los alias de correo asociados al servicio/alojamiento
    resources/emailalias/value integer Número de alias de correo creados
    resources/emailalias/max integer Número máximo posible de alias de correo
    resources/emailalias/unit string N/A
    infoType = php
    php/enabled boolean (bool) Indica si PHP está activado en el servicio
    php/version string Versión de PHP actual
    php/name string Texto indicando la versión de PHP actual
    php/available Array Listado de versiones de PHP disponibles
    infoType = serverinfo
    serverinfo Array Información sobre servidores asociados al servicio/alojamiento
    serverinfo/ftpServer string Nombre del servidor FTP
    serverinfo/ftpAbsolutePath string Ruta del home del servidor FTP
    serverinfo/ftpWebServer string URL de acceso al servicio de Web FTP
    serverinfo/smtpServer string Nombre del servidor SMTP para el correo saliente
    serverinfo/pop3server string Nombre del servidor de correo POP3
    serverinfo/imapserver string Nombre del servidor de correo IMAP
    serverinfo/webmail string URL de acceso al servicio de correo web
    serverinfo/ddbbserver string Nombre del servidor de base de datos
    serverinfo/PHPMyAdmin string URL de acceso al gestor de bases de datos PHPMyAdmin
    infoType = logerror
    logError string Lineas del log de errores del hosting

    8.3 service_create()

    Crea un nuevo servicio asociado a la cuenta del cliente.

    Petición:

    $response = $dondominio->service_create( array(
        'serviceName' => 'example.com',
        'productKey' => 'advanced',
        'period' => 1
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    productKey string Código de producto (ver tabla)
    period integer  No 1 Periodo durante el cual contratar el servicio (en años)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    billing Array Información de cobro de la operación
    billing/total float Importe de la operación
    billing/currency string Moneda usada para operación
     services Array Información sobre los servicios contratados
    services/name string Nombre del servicio
    services/status string Estado del servicio (ver tabla)
    services/type string Tipo de servicio
    services/productKey string Código de tipo de producto (ver tabla)
    services/tsExpir string Fecha de expiración del servicio

    8.4 service_renew()

    Extender el periodo de contratación de un servicio/alojamiento existente.

    Petición:

    $response = $dondominio->service_renew( 'example.com', array(
        'period' => 1
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    period integer No 1 Periodo por el cual extender la contratación, en años

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    billing Array Información de cobro de la operación
    billing/total float Importe de la operación
    billing/currency string Moneda usada para operación
     services Array Información sobre los servicios contratados
    services/name string Nombre del servicio
    services/status string Estado del servicio (ver tabla)
    services/type string Tipo de servicio
    services/productKey string Código de tipo de producto (ver tabla)
    services/tsExpir string Fecha de expiración del servicio

    8.5 service_upgrade()

    Ampliar el servicio a un plan superior.

    Petición:

    $response = $dondominio->service_upgrade();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    productKey string Nuevo código de producto (ver tabla)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    billing Array Información de cobro de la operación
    billing/total float Importe de la operación
    billing/currency string Moneda usada para operación
     services Array Información sobre los servicios contratados
    services/name string Nombre del servicio
    services/status string Estado del servicio (ver tabla)
    services/type string Tipo de servicio
    services/productKey string Código de tipo de producto (ver tabla)
    services/tsExpir string Fecha de expiración del servicio

    8.6 service_update()

    Modificar configuración global de un servicio/alojamiento.

    Petición:

    $response = $dondominio->service_update( 'example.com', array(
        'updateType' => 'renewalMode',
        'renewalMode' => 'autorenew'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    updateType string Tipo de información a actualizar:
    renewalMode: Modo de renovación de los servicios
    phpversion: Cambia la versión de PHP
    updateType = renewalMode
    renewalMode string Modo de renovación (ver tabla)
    updateType = phpversion
    phpversion string Versión de PHP a aplicar

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    name string Nombre del servicio/alojamiento
    status string Estado del servicio/alojamiento
    type string Tipo de servicio
    productKey string Código de producto del servicio/alojamiento
    tsExpir string Fecha de expiración del servicio/alojamiento
    updateType = phpversion
    php/enabled boolean Indica si PHP está activado en el servicio
    php/version string Versión de PHP actual
    php/name string Texto indicando la versión de PHP actual
    php/available array Listado de versiones de PHP disponibles

    8.7 service_parkingGetInfo()

    Obtiene información sobre el servicio de parking.

    Petición:

    $response = $dondominio->service_parkingGetInfo( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    parking Array Información sobre el servicio de parking
    parking/enabled boolean Indica si el servicio de parking está activo

    8.8 service_parkingUpdate()

    Modifica la configuración del servicio de parking.

    Petición:

    $response = $dondominio->service_parkingUpdate( 'example.com', array(
        'enabled' => true
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    enabled boolean Activar o desactivar el servicio de parking

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    parking Array Información sobre el servicio de parking
    parking/enabled boolean Indica si el servicio de parking está activo

    8.9 service_webconstructorLogin()

    Recupera la URL necesaria para acceder al servicio WebConstructor asociado al servicio.

    Petición:

    $response = $dondominio->service_webconstructorLogin();

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    subdomain string Subdominio donde se publicará la web
    loginlang string No en Idioma por defecto de la interfaz del WebConstructor; el usuario puede cambiarlo posteriormente

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    webconstructor Array Información sobre el servicio de WebConstrucor
    webconstructor/loginURL string URL para acceder al servicio de WebConstructor

    8.10 service_ftpList()

    Realizar un listado/búsqueda de cuentas FTP asociadas a un servicio.

    Petición:

    $response = $dondominio->service_ftpList( 'example.com', array(
        'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
    ftp/entityID string Identificador único
    ftp/name string Nombre de la cuenta FTP
    ftp/ftpPath string Ruta home de la cuenta FTP
    ftp/password string Contraseña de la cuenta FTP
    ftp/quota integer Cuota, en bytes, de la cuenta FTP

    8.11 service_ftpGetInfo()

    Obtiene información sobre una cuenta FTP.

    Petición:

    $response = $dondominio->service_ftpGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ftp Array Información recuperada sobre el elemento
    ftp/entityID string Identificador único del elemento
    ftp/name string Nombre de la cuenta FTP
    ftp/ftpPath string Ruta home de la cuenta FTP
    ftp/password string Contraseña de la cuenta FTP
    ftp/quota integer Cuota asignada a la cuenta FTP, en bytes

    8.12 service_ftpCreate()

    Crear una nueva cuenta FTP.

    Petición:

    $response = $dondominio->service_ftpCreate( 'example.com', array(
        'name' => 'example',
        'ftpPath' => '/',
        'password' => 'xxxxxx',
        'quota' => 1048576
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    name string Nombre de la cuenta FTP
    ftpPath string Ruta home de la cuenta FTP
    password string Contraseña de acceso a la cuenta FTP
    quota integer Cuota asignada a la cuenta, en bytes (mínimo 1048576 bytes / 1 MByte)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ftp Array Datos del elemento creado
    ftp/entityID string Identificador único asignado al elemento
    ftp/name string Nombre de la cuenta FTP
    ftp/ftpPath  string Ruta home de la cuenta FTP
     ftp/password string  Contraseña de la cuenta FTP
    ftp/quota integer  Cuota de la cuenta FTP, en bytes

    8.13 service_ftpUpdate()

    Modifica la configuración y parámetros de una cuenta FTP existente.

    Petición:

    $response = $dondominio->service_ftpUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'ftpPath' => '/',
        'password' => 'xxxxxx',
        'quota' => 1048576
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    ftpPath string Ruta home de la cuenta FTP
    password string Contraseña de acceso a la cuenta FTP
    quota integer Cuota asignada a la cuenta, en bytes (mínimo 1048576 bytes / 1 MByte)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ftp Array Datos del elemento creado
    ftp/entityID string Identificador único asignado al elemento
    ftp/name string Nombre de la cuenta FTP
    ftp/ftpPath  string Ruta home de la cuenta FTP
     ftp/password string  Contraseña de la cuenta FTP
    ftp/quota integer  Cuota de la cuenta FTP, en bytes

    8.14 service_ftpDelete()

    Elimina una cuenta de FTP.

    Petición:

    $response = $dondominio->service_ftpDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.15 service_databaseList()

    Realizar un listado/búsqueda de cuentas de base de datos asociadas a un servicio.

    Petición:

    $response = $dondominio->service_databaseList( 'example.com', array(
        'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
     ddbb Array Resultados obtenidos
    ddbb/entityID string Identificador único
    ddbb/name string Nombre de la base de datos
    ddbb/user string Nombre de usuario de acceso a la cuenta
    ddbb/password string Contraseña de la base de datos
    ddbb/externalAccess boolean Indica si se puede acceder desde el exterior a la base de datos

    8.16 service_databaseGetInfo()

    Obtiene información sobre una base de datos.

    Petición:

    $response = $dondominio->service_databaseGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ddbb Array Información recuperada sobre el elemento
    ddbb/entityID string Identificador único del elemento
    ddbb/name string Nombre de la base de datos
    ddbb/user string Nombre de usuario con acceso a la base de datos
    ddbb/password string Contraseña de acceso a la base de datos
    ddbb/externalAccess boolean Indica si se puede acceder externamente a la base de datos

    8.17 service_databaseCreate()

    Crear una nueva base de datos.

    Petición:

    $response = $dondominio->service_databaseCreate( 'example.com', array(
        'password' => 'xxxxx',
        'externalAccess' => false
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    password  string   Contraseña de la base de datos
    externalAccess boolean No false Activar o desactivar el acceso externo a la base de datos

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ddbb Array Datos del elemento creado
    ddbb/entityID string Identificador único asignado al elemento
    ddbb/name string Nombre de la base de datos
    ddbb/user  string Nombre de usuario de la base de datos
     ddbb/password string Contraseña de acceso a la base de datos
    ddbb/externalAccess boolean Indica si se puede acceder externamente a la base de datos

    8.18 service_databaseUpdate()

    Modifica la configuración y parámetros de una base de datos existente.

    Petición:

    $response = $dondominio->service_databaseUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'password' => 'xxxxxx',
        'externalAccess' => false
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    password  string   Contraseña de la base de datos
    externalAccess boolean No false Activar o desactivar el acceso externo a la base de datos

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    ddbb Array Datos del elemento creado
    ddbb/entityID string Identificador único asignado al elemento
    ddbb/name string Nombre de la base de datos
    ddbb/user  string Nombre de usuario de la base de datos
     ddbb/password string Contraseña de acceso a la base de datos
    ddbb/externalAccess boolean Indica si se puede acceder externamente a la base de datos

    8.19 service_databaseDelete()

    Elimina una base de datos.

    Petición:

    $response = $dondominio->service_databaseDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.20 service_subdomainList()

    Realizar un listado/búsqueda de subdominios asociados a un servicio.

    Petición:

    $response = $dondominio->service_subdomainList( 'example.com', array(
        'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No 1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
    subdomain Array Resultados obtenidos
    subdomain/entityID string Identificador único
    subdomain/name string Nombre del subdominio
    subdomain/ftpPath string Ruta de acceso FTP del subdominio
    subdomain/ssl Array Información del Certificado SSL. (Sólo cuando el subdominio tiene un Certificado instalado)
    subdomain/ssl/sslPath string Ruta segura del FTP
    subdomain/ssl/sslCert string Archivo CRT del certificado
    subdomain/ssl/sslKey string Archivo KEY del certificado
    subdomain/ssl/sslCertChain string Archivo CA-CRT del certificado

    8.21 service_subdomainGetInfo()

    Obtiene información sobre un subdominio.

    Petición:

    $response = $dondominio->service_subdomainGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    subdomain Array Información recuperada sobre el elemento
    subdomain/entityID string Identificador único del elemento
    subdomain/name string Nombre del subdominio
    subdomain/ftpPath string Ruta FTP al subdominio

    8.22 service_subdomainCreate()

    Crear un nuevo subdominio.

    Petición:

    $response = $dondominio->service_subdomainCreate( 'example.com', array(
        'name' => 'test.example.com',
        'ftpPath' => 'public-test/'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    name string Nombre del subdominio
    ftpPath string Ruta FTP del subdominio
    sslCert string No Archivo CRT del certificado
    sslKey string si sslCert es enviado Archivo KEY del certificado
    sslCertChain string si sslCert es enviado Archivo CA-CRT del certificado
    sslPath string si sslCert es enviado Ruta segura del FTP

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    subdomain Array Datos del elemento creado
    subdomain/entityID string Identificador único asignado al elemento
    subdomain/name string Nombre del subdominio
    subdomain/ftpPath string Ruta FTP del subdominio
    subdomain/ssl Array Información del Certificado SSL. (Sólo cuando el subdominio tiene un Certificado instalado)
    subdomain/ssl/sslPath string Ruta segura del FTP
    subdomain/ssl/sslCert string Archivo CRT del certificado
    subdomain/ssl/sslKey string Archivo KEY del certificado
    subdomain/ssl/sslCertChain string Archivo CA-CRT del certificado

    8.23 service_subdomainUpdate()

    Modifica la configuración y parámetros de un subdominio existente.

    Petición:

    $response = $dondominio->service_subdomainUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'ftpPath' => 'public-test/',
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    ftpPath string Ruta FTP del subdominio
    sslCert string No Archivo CRT del certificado
    sslKey string si sslCert es enviado Archivo KEY del certificado
    sslCertChain string si sslCert es enviado Archivo CA-CRT del certificado
    sslPath string si sslCert es enviado Ruta segura del FTP

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    subdomain Array Datos del elemento creado
    subdomain/entityID string Identificador único asignado al elemento
    subdomain/name string Nombre del subdominio
    subdomain/ftpPath string Ruta FTP del subdominio
    subdomain/ssl Array Información del Certificado SSL. (Sólo cuando el subdominio tiene un Certificado instalado)
    subdomain/ssl/sslPath string Ruta segura del FTP
    subdomain/ssl/sslCert string Archivo CRT del certificado
    subdomain/ssl/sslKey string Archivo KEY del certificado
    subdomain/ssl/sslCertChain string Archivo CA-CRT del certificado

    8.24 service_subdomainDelete()

    Elimina un subdominio.

    Petición:

    $response = $dondominio->service_subdomainDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.25 service_redirectList()

    Realizar un listado/búsqueda de redirecciones asociadas a un servicio.

    Petición:

    $response = $dondominio->service_redirectList( 'example.com', array(
        'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
     redirect Array Resultados obtenidos
    redirect/entityID string Identificador único
    redirect/origin string Origen de la redirección
    redirect/destination string Destino de la redirección
    redirect/type string Tipo de redirección (ver tabla)

    8.26 service_redirectGetInfo()

    Obtiene información sobre una redirección.

    Petición:

    $response = $dondominio->service_redirectGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    redirect Array Información recuperada sobre el elemento
    redirect/entityID string Identificador único del elemento
    redirect/origin string Origen de la redirección
    redirect/destination string Destino de la redirección
     redirect/type string Tipo de redirección (ver tabla)

    8.27 service_redirectCreate()

    Crear una nueva redirección.

    Petición:

    $response = $dondominio->service_redirectCreate( 'example.com', array(
        'origin' => 'http://example.com/example01/',
        'destination' => 'http://example.com/example02/',
        'type' => '301'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    origin string Origen de la redirección
    destination string Destino de la redirección
    type string Tipo de redirección (ver tabla)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    redirect Array Datos del elemento creado
    redirect/entityID string Identificador único asignado al elemento
    redirect/origin string Origen de la redirección 
    redirect/destination string  Destino de la redirección
    redirect/type string Tipo de redirección (ver tabla)

    8.28 service_redirectUpdate()

    Modifica la configuración y parámetros de una redirección existente.

    Petición:

    $response = $dondominio->service_redirectUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'destination' => 'http://example.com/example02',
        'type' => '301'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    destination string Destino de la redirección
    type string Tipo de redirección (ver tabla)

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    redirect Array Datos del elemento creado
    redirect/entityID string Identificador único asignado al elemento
    redirect/origin string Origen de la redirección 
    redirect/destination string  Destino de la redirección
    redirect/type string Tipo de redirección (ver tabla)

    8.29 service_redirectDelete()

    Elimina una redirección.

    Petición:

    $response = $dondominio->service_redirectDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.30 service_mailList()

    Realizar un listado/búsqueda de cuentas de correo asociadas a un servicio.

    Petición:

    $response = $dondominio->service_mailList( 'example.com', array(
        ss'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No 1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
    mail Array Resultados obtenidos
    mail/entityID string Identificador único
    mail/name string Nombre de la cuenta de correo
    mail/password string Contraseña de la cuenta de correo
    mail/usage integer Ocupación del buzón (En Bytes)
    mail/quotaMax integer Capacidad del buzón (En Bytes)

    8.31 service_mailGetInfo()

    Obtiene información sobre una cuenta de correo electrónico.

    Petición:

    $response = $dondominio->service_mailGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    mail Array Información recuperada sobre el elemento
    mail/entityID string Identificador único del elemento
    mail/name string Nombre de la cuenta de correo
    mail/password string Contraseña de la cuenta de correo
    mail/usage integer Ocupación del buzón (En Bytes)
    mail/quotaMax integer Capacidad del buzón (En Bytes)

    8.32 service_mailCreate()

    Crear una nueva cuenta de correo electrónico.

    Petición:

    $response = $dondominio->service_mailCreate( 'example.com', array(
        'name' => 'john.doe@example.com',
        'password' => 'xxxxxx'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    name string Nombre de la cuenta de correo
    password string Contraseña de la cuenta de correo

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    mail Array Datos del elemento creado
    mail/entityID string Identificador único asignado al elemento
    mail/name string Nombre de la cuenta de correo
    mail/password string Contraseña de la cuenta de correo
    mail/usage integer Ocupación del buzón (En Bytes)
    mail/quotaMax integer Capacidad del buzón (En Bytes)

    8.33 service_mailUpdate()

    Modifica la configuración y parámetros de una cuenta de correo electrónico existente.

    Petición:

    $response = $dondominio->service_mailUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'password' => 'xxxxxx'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    password string Contraseña de la cuenta de correo

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    mail Array Datos del elemento creado
    mail/entityID string Identificador único asignado al elemento
    mail/name string Nombre de la cuenta de correo
    mail/password string Contraseña de la cuenta de correo
    mail/usage integer Ocupación del buzón (En Bytes)
    mail/quotaMax integer Capacidad del buzón (En Bytes)

    8.34 service_mailDelete()

    Elimina una cuenta de correo electrónico.

    Petición:

    $response = $dondominio->service_mailDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.35 service_mailAliasList()

    Realizar un listado/búsqueda de alias de correo asociados a un servicio.

    Petición:

    $response = $dondominio->service_mailAliasList( 'example.com', array(
        'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
     mailalias Array Resultados obtenidos
    mailalias/entityID string Identificador único
    mailalias/name string Nombre del alias de correo
    mailalias/target  string Cuenta de destino del alias de correo

    8.36 service_mailAliasGetInfo()

    Obtiene información sobre un alias de correo electrónico.

    Petición:

    $response = $dondominio->service_mailAliasGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    mailalias Array Información recuperada sobre el elemento
    mailalias/entityID string Identificador único del elemento
    mailalias/name string Nombre del alias de correo
    mailalias/target  string Cuenta de destino del alias de correo

    8.37 service_mailAliasCreate()

    Crear un nuevo alias de correo electrónico.

    Petición:

    $response = $dondominio->service_mailAliasCreate( 'example.com', array(
        'name' => 'jane.doe@example.com',
        'target' => 'john.doe@example.com'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    name string Nombre del alias de correo
    target string Cuenta de correo de destino del alias

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    mailalias Array Datos del elemento creado
    mailalias/entityID string Identificador único asignado al elemento
    mailalias/name string Nombre del alias de correo
    mailalias/target string Cuenta de correo de destino del alias

    8.38 service_mailAliasUpdate()

    Modifica la configuración y parámetros de un alias correo electrónico existente.

    Petición:

    $response = $dondominio->service_mailAliasUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'target' => 'jane.doe@example.com'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    target string Cuenta de correo de destino del alias

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    mailalias Array Datos del elemento creado
    mailalias/entityID string Identificador único asignado al elemento
    mailalias/name string Nombre del alias de correo
    mailalias/target string Cuenta de correo de destino del alias

    8.39 service_mailAliasDelete()

    Elimina un alias de correo electrónico.

    Petición:

    $response = $dondominio->mailAliasDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.40 service_dnsList()

    Realizar un listado/búsqueda de zonas DNS asociadas a un servicio.

    Petición:

    $response = $dondominio->service_dnsList( 'example.com', array(
        'pageLength' => 1000,
        'page' => 1,
        'filter' => 'text'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    pageLength integer No  1000 Resultados por página
    page integer No 1 Página de resultados
    filter string No Filtrar resultados por texto
    filterType string No Filtro por tipo
    filterValue string No Filtro por valor

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page integer Página de resultados
    queryInfo/pageLength integer Resultados por página
    queryInfo/results integer Número de resultados obtenidos
    queryInfo/total integer Número total de resultados
     dns Array Resultados obtenidos
    dns/entityID string Identificador único
     dns/name  string Nombre de la zona DNS
    dns/type string Tipo de zona DNS (ver tabla)
    dns/ttl string Time To Live ("-" = Por defecto)
    dns/priority string Prioridad de la zona ("-" = Por defecto)
    dns/value string Valor de la zona (depende del tipo seleccionado)

    8.41 service_dnsGetInfo()

    Obtiene información sobre una zona DNS.

    Petición:

    $response = $dondominio->service_dnsGetInfo( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    dns Array Información recuperada sobre el elemento
    dns/entityID string Identificador único del elemento
    dns/name string Nombre de la zona DNS
    dns/type  string Tipo de zona DNS (ver tabla)
    dns/ttl string Time To Live ("-" = Por defecto)
    dns/priority string Prioridad de la zona ("-" = Por defecto)
    dns/value string Valor de la zona DNS, dependiendo del tipo

    8.42 service_dnsCreate()

    Crear una nueva zona DNS.

    Petición:

    $response = $dondominio->service_dnsCreate( 'example.com', array(
        'name' => 'example.com',
        'type' => 'A',
        'value' => '0.0.0.0'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    name string Nombre de la zona DNS
    type string Tipo de zona DNS (ver tabla)
    value string Valor de la zona DNS (según tipo)
    ttl integer No Time To Live
    priority integer No 10 para tipos MX y SRV Prioridad de la zona DNS

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    dns Array Datos del elemento creado
    dns/entityID string Identificador único asignado al elemento
    dns/name string Nombre de la zona DNS
    dns/type  string  Tipo de la zona DNS (ver tabla)
    dns/ttl string  Time to Live ("-" = Por defecto)
    dns/priority string  Prioridad de la zona DNS ("-" = Por defecto)
    dns/value string Valor de la zona según su tipo

    8.43 service_dnsUpdate()

    Modifica la configuración y parámetros de una zona DNS existente.

    Petición:

    $response = $dondominio->service_dnsUpdate( 'example.com', 'SRV0000214277-000396074', array(
        'value' => '0.0.0.0'
    ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento
    value string Valor de la zona DNS (según tipo)
    ttl integer No Time To Live
    priority integer No 10 para tipos MX y SRV Prioridad de la zona DNS

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    dns Array Datos del elemento creado
    dns/entityID string Identificador único asignado al elemento
    dns/name string Nombre de la zona DNS
    dns/type  string  Tipo de la zona DNS (ver tabla)
    dns/ttl string  Time to Live ("-" = Por defecto)
    dns/priority string  Prioridad de la zona DNS ("-" = Por defecto)
    dns/value string Valor de la zona según su tipo

    8.44 service_dnsDelete()

    Elimina una zona DNS.

    Petición:

    $response = $dondominio->service_dnsDelete( 'example.com', 'SRV0000214277-000396074' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    entityID string Identificador único del elemento

    Esta llamada no devuelve información.


    8.45 service_dnsRestore()

    Restaura todas las zonas DNS de un servicio a sus valores por defecto.

    Petición:

    $response = $dondominio->service_dnsRestore( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio

    Esta llamada no devuelve información.


    8.46 service_dnsSetZone()

    Establece con una sola llamada las zonas DNS complets. Conlleva la eliminación de las zonas DNS actuales.

    Petición:

    $response = $dondominio->service_dnsSetZone( 'example.com', array( ... ));

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio
    dnsZoneData Array Array con todas las zonas DNS (ver tabla)

    Formato de dnsZoneData (Array multidimensional, una zona DNS por elemento)

    Parámetro  Tipo Descripción
    name string Nombre de la zona DNS
    type string Tipo de zona DNS (ver tabla)
    ttl string Time To Live ("-" = Por defecto)
    priority string Prioridad de la zona ("-" = Por defecto)
    value string  Valor de la zona dependiendo del tipo

    Ejemplo de dnsZoneData

    $dnsZoneData = array(
        array(
            'name' => 'example.com',
            'type' => 'A',
            'ttl' => '-',
            'priority' => '-',
            'value' => '0.0.0.0'
        ),
    
        array(
            'name' => '*.example.com',
            'type' => 'CNAME',
            'ttl' => '-',
            'priority' => '-',
            'value' => 'srv1.example1.com'
        )
    );

    Esta llamada no devuelve ninguna información.


    8.47 service_dnsDeleteAll()

    Elimina todas las zonas DNS de un servicio.

    Petición:

    $response = $dondominio->service_dnsDeleteAll( 'example.com' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    serviceName string Nombre del servicio

    Esta llamada no devuelve ninguna información.

    9 Módulo: SSL

    El módulo SSL provee herramientas para gestionar certificados SSL.

    Todos los métodos de este módulo están prefijados con ssl_.


    9.1 ssl_csrDecode()

    Decodifica los datos de un CSR.

    Petición:

    $response = $dondominio->ssl_csrDecode( '-----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-----');

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    csrData string Datos de CSR (incluyendo -----BEGIN----- y -----END-----)

    Descripción de los campos de respuesta:

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

    9.2 ssl_csrCreate()

    Crea un CSR.

    Petición:

    $response = $dondominio->ssl_csrCreate( array(
        'commonName' => 'example.domain.com',
        'organizationName' => 'Tech Solutions Inc',
        'organizationalUnitName' => 'Gotham Department',
        'countryName' => 'US',
        'stateOrProvinceName' => 'Arizona',
        'localityName' => 'Bapchule',
        'emailAddress' => 'info@example.com'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    commonName string Si Nombre común
    organizationName string Si Nombre de la organización
    organizationalUnitName string Si Nombre de unidad asociado al CSR
    countryName string Si Código de 2 caracteres del país
    stateOrProvinceName string Si Nombre de la provincia o estado de la compañía
    localityName string Si Nombre de la población de la compañía
    emailAddress string Si Correo electrónico asociado al CSR

    Descripción de los campos de respuesta:

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

    9.3 ssl_productList()

    Muestra un listado de los Certificados SSL disponibles

    Petición:

    $response = $dondominio->ssl_productList( array(
        'wildcard' => 'false',
        'multidomain' => 'false',
        'trial' => 'false',
        'validationType' => 'dv'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength Integer No 1000 Resultados por página
    page Integer No 1 Página de resultados
    wildcard Bool No (Bool) Filtrará por tipos que permitan wildcard
    multidomain Bool No (Bool) Filtrará por tipos que permitan multi-dominio
    trial Bool No (Bool) Filtrará por Certificados de prueba
    validationType string No Filtrará por el tipo de validación (Ver tabla)

    Descripción de los campos de respuesta:

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

    9.4 ssl_productGetInfo()

    Get information from a concrete product.

    Petición:

    $response = $dondominio->ssl_productGetInfo( 1 );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    productId Integer Si Identificador del producto

    Descripción de los campos de respuesta:

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

    9.5 ssl_list()

    Lista Certificados comprados mediante filtros.

    Petición:

    $response = $dondominio->ssl_list( array(
        'commonName' => 'example.com'
        'renewable' => 'true'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength Integer No 1000 Resultados por página
    page Integer No 1 Página de resultados
    productID Integer No Filtra por identificador de producto (Ver /ssl/productlist/
    status String No Filtra por el estado del Certificado (Ver tabla 8.5.2)
    renewable Bool No (Bool) Filtra si el Certificado es renovable o no
    commonName String No Filtra por el CommonName del Certificado

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page Integer Página de resultados
    queryInfo/pageLength Integer Resultados por página
    queryInfo/results Integer Número de resultados obtenidos
    queryInfo/total Integer Número total de resultados
    ssl Array Listado de Certificados SSL que cumplen con los filtros indicados
    ssl/certificateID Integer Identificador del Certificado
    ssl/commonName String CommonName
    ssl/status String Estado del Certificado
    ssl/renewable Bool Si el Certificado es renovable
    ssl/productID Integer Identificador del Producto
    ssl/tsCreate String Fecha de creación del Certificado
    ssl/tsExpir String Fecha de expiración del Certificado
    ssl/alternativeNames Array Dominios alternativos del Certificado

    9.6 ssl_getInfo()

    Muestra información de un Certificado comprado

    Petición:

    $response = $dondominio->ssl_getInfo( 56, array(
        'infoType' => 'ssldata'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    certificateID Integer Si Identificador del Certificado
    infoType String No status Información del Certificado (Ver siguiente tabla)
    pfxpass String No Permite enviar la contraseña cuando infoType=pfx

    Opciones del InfoType

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    status String No Información general del Certificado
    ssldata String No Datos del Certificados, archivos CRT, KEY y CA-CRT
    validationStatus String No Información sobre la validación del Certificado. Sólo cuando el estado del Certificado es process o reissue
    pfx String No Datos del Certificados en formato pfx
    der String No Datos del Certificados en formato der
    p7b String No Datos del Certificados en formato p7b
    zip String No Datos del Certificados en formato zip
    pem String No Datos del Certificados en formato pem

    Descripción de los campos de respuesta:

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

    9.7 ssl_create()

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

    Petición:

    $response = $dondominio->ssl_create( 3, array(
        'csrData' => '-----BEGIN CERTIFICATE REQUEST-----
                      ...
                      -----END CERTIFICATE REQUEST-----',
        'period' => 1,
        'keyData' => '-----BEGIN PRIVATE KEY-----
                      ...
                      -----END PRIVATE KEY-----',
        'adminContactID' => 'XXX-12312',
        'validationMethod' => 'admin@example.com',
        'alt_name_1' => 'www.example.com',
        'alt_validation_1' => 'https'
    ) );

    Parámetros de la petición:

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

    9.7.1 Especificar contactos

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

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

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    adminContactID string Si ID del contacto en DonDominio. Ejemplo: XXX-12312
    1. Facilitar toda la información necesaria: (Ejemplo para el contacto admin)

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

    Parámetros de la petición:

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

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

    9.7.2 Validación de los Nombres Alternativos

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

    Ejemplo con 2 Nombres Alternativos

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    alt_name_1 string Yes Primer Nombre Alternativo
    alt_validation_1 string Yes dns Método de validación del primero Nombre Alternativo
    alt_name_2 string Yes Segundo Nombre Alternativo
    alt_validation_2 string Yes dns Método de validación del segundo Nombre Alternativo

    9.7.3 Respuesta

    Descripción de los campos de respuesta:

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

    9.8 ssl_renew()

    Renueva un Certificado SSL.

    Petición:

    $response = $dondominio->ssl_renew( 3, array(
        'csrData' => '-----BEGIN CERTIFICATE REQUEST-----
                      ...
                      -----END CERTIFICATE REQUEST-----',
        'period' => 1,
        'keyData' => '-----BEGIN PRIVATE KEY-----
                      ...
                      -----END PRIVATE KEY-----',
        'adminContactID' => 'XXX-12312',
        'validationMethod' => 'admin@example.com',
        'alt_name_1' => 'www.example.com',
        'alt_validation_1' => 'https'
    ) );

    Parámetros de la petición:

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

    9.8.1 Especificar contactos

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

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

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    adminContactID string Si ID del contacto en DonDominio. Ejemplo: XXX-12312
    1. Facilitar toda la información necesaria: (Ejemplo para el contacto admin)

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

    Parámetros de la petición:

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

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

    9.8.2 Validación de los Nombres Alternativos

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

    Ejemplo con 2 Nombres Alternativos

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    alt_name_1 string Yes Primer Nombre Alternativo
    alt_validation_1 string Yes dns Método de validación del primero Nombre Alternativo
    alt_name_2 string Yes Segundo Nombre Alternativo
    alt_validation_2 string Yes dns Método de validación del segundo Nombre Alternativo

    9.8.3 Respuesta

    Descripción de los campos de respuesta:

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

    9.9 ssl_reissue()

    Reemite un Certificado SSL.

    Petición:

    $response = $dondominio->ssl_reissue( 3, array(
        'csrData' => '-----BEGIN CERTIFICATE REQUEST-----
                      ...
                      -----END CERTIFICATE REQUEST-----',
        'keyData' => '-----BEGIN PRIVATE KEY-----
                      ...
                      -----END PRIVATE KEY-----',
        'validationMethod' => 'admin@example.com',
        'alt_name_1' => 'www.example.com',
        'alt_validation_1' => 'https'
    ) );

    Parámetros de la petición:

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

    9.9.1 Validación de los Nombres Alternativos

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

    Ejemplo con 2 Nombres Alternativos

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    alt_name_1 string Yes Primer Nombre Alternativo
    alt_validation_1 string Yes dns Método de validación del primero Nombre Alternativo
    alt_name_2 string Yes Segundo Nombre Alternativo
    alt_validation_2 string Yes dns Método de validación del segundo Nombre Alternativo

    9.9.2 Respuesta

    Descripción de los campos de respuesta:

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

    9.10 ssl_multidomainaddsan()

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

    Petición:

    $response = $dondominio->ssl_multidomainaddsan( 3, array(
        'extraSAN' => 'www.example.com'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    certificateID integer Yes Identificador del certificado
    extraSAN string Yes Nombre alternativo que será añadido al Certificado SSL

    9.10.1 Respuesta

    Descripción de los campos de respuesta:

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

    9.11 ssl_getValidationEmails()

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

    Petición:

    $response = $dondominio->ssl_getValidationEmails( "example.com", array(
        'includeAlternativeMethods' => 'false'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    commonName string Si CommonName del Certificado.
    includeAlternativeMethods bool No true The response includes alternative validation methods to emails.

    Descripción de los campos de respuesta:

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

    9.12 ssl_changevalidationmethod()

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

    Petición:

    $response = $dondominio->ssl_changevalidationmethod( 56, array(
        "commonName" => "www.example.com",
        "validationMethod" => "https"
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    certificateID Integer Si Identificador del Certificado
    commonName String Si CommonName
    validationMethod String Si Nuevo método de validación

    Descripción de los campos de respuesta:

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

    9.13 ssl_resendvalidationmail()

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

    Petición:

    $response = $dondominio->ssl_resendvalidationmail( 56, array(
        "commonName" => "www.example.com",
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    certificateID Integer Si Identificador del Certificado
    commonName String Si CommonName

    Descripción de los campos de respuesta:

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

    10 Módulo: User

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

    Todos los métodos de este módulo están prefijados con user_.


    10.1 user_create()

    Crea un usuario externo.

    Petición:

    $response = $dondominio->user_create( array(
        'username' => 'admin2',
        'password' => 'admin1234'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario del usuario externo
    password string Contraseña del usuario externo

    Descripción de los campos de respuesta:

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

    10.2 user_list()

    Lista todos los usuarios externos de la cuenta.

    Petición:

    $response = $dondominio->user_list( array(
        'status' => 'enabled'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    pageLength Integer No 1000 Resultados por página
    page Integer No 1 Página de resultados
    status string No Estado del usuario externo (Ver tabla)
    username string No Buscar usuarios por el nombre de usuario
    domainName string No Buscar por los dominios de los usuarios

    Descripción de los campos de respuesta:

    Campo Tipo Descripción
    queryInfo Array Información sobre la consulta realizada
    queryInfo/page Integer Página de resultados
    queryInfo/pageLength Integer Resultados por página
    queryInfo/results Integer Número de resultados obtenidos
    queryInfo/total Integer Número total de resultados
    users array Información de usuarios
    users/username string Nombre de usuario
    users/status string Estado del usuario
    users/lastlogin string Día del último acceso
    users/numDomains integer Dominios asociados al usuario

    10.3 user_getinfo()

    Obtiene información sobre un usuario en concreto.

    Petición:

    $response = $dondominio->user_getinfo( 'admin1' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario

    Descripción de los campos de respuesta:

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

    10.4 user_updatestatus()

    Actualiza el estado de un usuario.

    Petición:

    $response = $dondominio->user_updatestatus( 'admin1', array(
        'status' => 'enabled'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario
    status string Estado del usuario a aplicar (See table)

    Descripción de los campos de respuesta:

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

    10.5 user_updatepassword()

    Actualiza la contraseña de un usuario.

    Petición:

    $response = $dondominio->user_updatepassword( 'admin1', 'admin1234' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario
    password string Contraseña a aplicar

    Descripción de los campos de respuesta:

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

    10.6 user_adddomain()

    Añade un dominio a un usuario.

    Petición:

    $response = $dondominio->user_adddomain( 'admin1', array(
        'domainName' => 'example.tv',
        'domain_ownercontacts' => 'read'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario
    domainName string Dominio a eliminar
    [Permiso]=[valor] string No Por defecto los permisos son creados con el valor por defecto del sistema El permiso a aplicar (Ver tabla)

    Ejemplo del parámetro de permisos

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain_ownercontacts=read string No El usuario podrá ver la información del contacto titular del dominio, pero no modificarlo

    Descripción de los campos de respuesta:

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

    10.7 user_updatedomain()

    Actualiza los permisos de un dominio.

    Petición:

    $response = $dondominio->user_updatedomain( 'admin1', array(
        'domainName' => 'example.tv',
        'domain_ownercontacts' => 'read'
    ) );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario
    domainName string Dominio a actualizar
    [Permiso]=[valor] string No Por defecto los permisos son creados con el valor por defecto del sistema El permiso a aplicar (Ver tabla)

    Ejemplo del parámetro de permisos

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    domain_ownercontacts=read string No El usuario podrá ver la información del contacto titular del dominio, pero no modificarlo

    Descripción de los campos de respuesta:

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

    10.8 user_deletedomain()

    Elimina un dominio de un usuario.

    Petición:

    $response = $dondominio->user_deletedomain( 'admin1', 'example.tv' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Nombre de usuario
    domainName string Dominio a eliminar

    Descripción de los campos de respuesta:

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

    10.9 user_delete()

    Elimina un usuario externo.

    Petición:

    $response = $dondominio->user_delete( 'admin1' );

    Parámetros de la petición:

    Parámetro Tipo Necesario Valor por defecto Descripción
    username string Yes Nombre de usuario

    Descripción de los campos de respuesta:

    Campo Tipo Descripción

    11 Anexo I


    11.1 Tablas

    Las tablas con los valores contenidos en los campos que indican "(ver tabla)" están disponibles en la documentación de la API de DonDominio.