Módulos para WHMCS

    Plugin de registro para WHMCS

    Manual de usuario del Plugin de Registro para WHMCS
    DonDominio

    Descargar desde Github

    1 Introducción

    Este es el manual de usuario para el Plugin de Registro para WHMCS de DonDominio.

    Este plugin añade la capacidad a WHMCS de registrar, transferir y renovar dominios a través de la API de DonDominio. También proporciona servicios adicionales como la actualización y gestión de contactos, gestión de servicios adicionales (como privacidad de whois) y otros.

    Este plugin sólo añade capacidad a WHMCS para registrar, transferir y renovar dominios con WHMCS. Existe un addon adicional para WHMCS que gestiona dominios y TLDs desde el panel de administración de WHMCS. Para más información sobre este addon, visita la documentación del Addon de DonDominio para WHMCS.

    1.1 Consideraciones previas

    El Plugin de Registro para WHMCS de DonDominio utiliza la API de DonDominio para funcionar. Es necesario disponer de una cuenta de API activa para poder usar este plugin.

    Para activar el plugin necesitarás un Nombre de usuario de API y una Contraseña de usuario de API que habrá proporcionado previamente el equipo de soporte de DonDominio. Para más información sobre la API de DonDominio, consulta la documentación correspondiente.

    1.2 Aviso legal

    WHMCS es una marca registrada de WHMCS Ltd.. DonDominio no forma parte ni está afiliado en ninguna forma a WHMCS Ltd.. Puedes obtener más información sobre WHMCS en la página web oficial de WHMCS.

    2 Instalación del plugin

    Para instalar el plugin, descarga el archivo ZIP correspondiente desde nuestro repositorio de Github. Una vez esté descargado, descomprímelo y deberías obtener una carpeta llamada dondominio. Copia esta carpeta al directorio de Addons de tu instalación de WHMCS, normalmente /path/to/whmcs/modules/registrars/.

    Una vez copiada la carpeta, accede al panel de administración de WHMCS y dirígite a la pantalla de configuración de registradores, Ajustes > Productos/Servicios > Registradores de dominios. Localiza el Addon llamado Dondominio y pulsa sobre el botón Activar. Una vez activado el módulo, pulsa sobre el botón Configurar e introduce la configuración necesaria para que el plugin funcione.

    Addons

    2.1 Configuración del plugin

    Las posibles configuraciones del plugin son las siguientes:

    Campo Valores Descripción
    API Username Texto Nombre de usuario de la API de DonDominio
    API Password Texto Contraseña de la API de DonDominio
    VAT Number Field Múltiple Campo personalizado que contiene el NIF/CIF/VAT del cliente
    Owner Contact DonDominio ID Texto ID de contacto de DonDominio para el propietario
    Allow customers to modify Owner contact information Sí/No Si está activo, los clientes podrán modificar los datos del propietario aunque se haya proporcionado un ID de contacto
    Admin Contact DonDominio ID Texto ID de contacto de DonDominio para el contacto administrativo
    Allow customers to modify Admin contact information Sí/No Si está activo, los clientes podrán modificar los datos del contacto administrativo aunque se haya proporcionado un ID de contacto
    Tech Contact DonDominio ID Texto ID de contacto de DonDominio para el contacto técnico
    Allow customers to modify Tech contact information Sí/No Si está activo, los clientes podrán modificar los datos del contacto técnico aunque se haya proporcionado un ID de contacto
    Billing Contact DonDominio ID Texto ID de contacto de DonDominio para el contacto de cobro
    Lock modifications Sí/No Si está activo al bloquear transferencias en un dominio también se bloquearán las modificaciones

    2.2 Campo personalizado

    La API de DonDominio requiere que se proporcione el NIF/CIF/Número VAT del cliente que registra el dominio para poder hacerlo efectivo. El plugin de DonDominio para WHMCS incluye una modificación a la manera en que WHMCS gestiona estos campos personalizados para que este campo aparezca en todas las extensiones de dominio y no sólo en algunas.

    Para activar la modificación, es necesario editar el fichero /includes/additionaldomainfields.php incluido en la instalación de WHMCS 6, o bien el fichero /resources/domains/dist.additionalfields.php incluido en la instalación de WHMCS 7.

    Al final de este fichero, debe añadirse esta línea:

    include(ROOTDIR . "/modules/registrars/dondominio/additionaldomainfields.php");

    Además, el plugin incluye un sistema para tomar un campo por defecto en caso de que este no esté disponible. Este campo se añadirá al perfil del cliente y es necesario en caso de renovaciones y otras operaciones con contactos.

    Addons

    Para añadir este campo, accede al panel de administración de WHMCS y luego haz clic en Ajustes > Campos personalizados. En el formulario que aparecerá, introduce los siguientes datos:

    Addons

    • Nombre del campo: VAT Number
    • Tipo de campo: Campo de texto

    El resto de campos pueden quedar en blanco. Activa también las casillas Campo obligatorio y Mostrar en el formulario de pedido.

    Consulta la sección Configuración del plugin para más información sobre como configurar este campo en el plugin.

    3 Usando el plugin

    Una vez instalado y configurado ya se puede usar el plugin para registrar, transferir y renovar dominios.

    Para que WHMCS use el plugin debe configurarse cada TLD para que haga uso del mismo. Puedes automatizar esta tarea usando nuestro Addon para WHMCS o bien manualmente siguiendo estos pasos:

    1. Accede a Ajustes > Productos/Servicios > Precios de dominios
    2. Si todavía no has creado el TLD que deseas usar, añádelo de forma normal introduciendo la extensión en el campo TLD y pulsa Guardar cambios. Si el TLD ya está creado, ignora este paso.
    3. Configura los precios pulsando en Abrir precios como desees
    4. En el campo Autoregistro selecciona Dondominio en el desplegable
    5. Pulsa Guardar cambios para confirmar la configuración

    Addons

    A partir de ese momento el TLD configurado usará el plugin de DonDominio para registrar, transferir y renovar dominios. El proceso se hará de forma transparente para el cliente.

    3.1 Procesando errores

    Si se produce un error a la hora de registrar, transferir o renovar un dominio, el pedido del cliente quedará en estado Pendiente. Pulsa sobre el enlace X pedidos pendientes en la parte superior de WHMCS para verlos.

    Puedes reintentar el proceso pulsando sobre Aceptar pedido para cada uno de ellos. Si se produce un error verás una descripción en pantalla. Si la operación tiene éxito el pedido quedará aceptado y el dominio activo en WHMCS.

    3.2 Sincronización automática

    El plugin incluye un servicio de sincronización automática para WHMCS. Este proceso funciona de forma automática, siempre y cuando hayas configurado las tareas Cron de WHMCS, tal y como indica la documentación de WHMCS sobre tareas Cron.

    El servicio de sincronización actualizará el estado de los dominios pendientes de transferencia y el estado (y fecha de expiración) del resto de dominios en tandas de 50 en 50. Cuando todos los dominios están sincronizados, el proces empieza de nuevo desde el primero, y así indefinidamente.

    4 Servicios adicionales

    El plugin de DonDominio para WHMCS incluye servicios adicionales para los clientes. Estos servicios se describen a continuación, y están accesibles desde el panel de gestión de clientes.

    4.1 Privacidad de whois

    Debido a que el sistema que WHMCS incorpora para gestionar la privacidad de whois puede crear conflictos cuando un dominio tiene las modificaciones bloqueadas, el plugin incorpora una opción personalizada que permite activar y desactivar la privacidad.

    En WHMCS 5.x
    Esta opción aparecerá como una opción de menú en la pestaña Herramientas de Gestión llamada WHOIS Privacy, en la pantalla de detalles de dominio.

    En WHMCS 6.x
    Esta opción aparecerá como una opción de menú en la barra lateral, bajo el bloque Servicios adicionales, llamada Privacidad de Whois.

    En ambas versiones, al hacer clic en esta opción aparecerá una pantalla con un botón que permite activar y desactivar este servicio. Los cambios se aplican inmediatamente a través de la API de DonDominio.

    Ten en cuenta que algunos TLDs no disponen del servicio de privacidad de Whois. Ten en cuenta también que existe una configuración adicional relacionada con este servicio en la configuración del plugin.