Módulos para WHMCS

    Addon para funciones avanzadas

    Manual de usuario para la Herramienta de Gestión de Dominios para WHMCS
    DonDominio

    Descargar desde Github

    1 Introducción

    Este es el manual de usuario para el Addon para funciones avanzadas para WHMCS de DonDominio.

    Este software añade capacidad a WHMCS para usar la API de DonDominio desde el panel de administración para diversas tareas, como por ejemplo:

    • Sincronización de dominios automática
    • Creación de nuevos TLDs
    • Gestión de TLDs y dominios existentes en WHMCS
    • Alertas personalizables
    • Proxy de whois para comprobar la disponibilidad de dominios

    1.1  Consideraciones previas

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

    Para activar el Addon 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 Funciones disponibles

    El módulo permite las siguientes acciones:

    • Actualizar precios y configurar TLDs existentes en WHMCS
    • Añadir nuevos TLDs soportados por DonDominio pero no configurados en WHMCS
    • Actualizar los datos y configurar dominios existentes en WHMCS
    • Importar dominios desde la cuenta de DonDominio que no existan en WHMCS todavía
    • Notificar sobre nuevos TLDs disponibles y cambios de tarifas

    El módulo añadirá un hook de WHMCS de forma automática para actualizar datos desde la API de DonDominio periódicamente. Puedes obtener más información sobre los hooks de WHMCS en su apartado correspondiente de la documentación de WHMCS.

    1.3 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

    Para instalar el Addon, descarga el archivo ZIP correspondiente desde nuestro repositorio de Github. Una vez esté descargado, descomprímelo y deberías obtener una carpeta llamada src. Copia el contenido de esta carpeta al directorio raíz de WHMCS, normalmente /path/to/whmcs/ y acepta todos los cambios.

    Una vez copiado el contenido de la carpeta, accede al panel de administración de WHMCS y dirígite a la pantalla de configuración de Addons, Ajustes > Módulos extra. Localiza el Addon llamado DonDominio Manager Addon y pulsa sobre el botón Activar. Una vez activado el módulo, pulsa sobre el botón Configurar y ajusta los roles de usuario que deseas que puedan acceder a este Addon (normalmente, Full Administrator).

    Addons

    Si el módulo se ha activado correctamente ahora debería estar todo preparado para configurarlo y empezar a usarlo.

    2.1 Configuración mínima

    Para empezar a usar el módulo, primero debe ser configurado. La configuración mínima requerida es el nombre de usuario de la API de DonDominio y la contraseña correspondiente. Para introducir ambos datos, accede al módulo haciendo clic en Módulos > DonDominio Manager.

    Menu

    Dado que aún no ha sido introducida la configuración, no podrás acceder a ninguna opción hasta que no proporciones estos datos. Introduce tu usuario y contraseña de la API de DonDominio en los campos correspondientes y luego pulsa Guardar cambios. Si el usuario y la contraseña son correctos, el módulo intentará hacer una sincronización inicial usando la API de DonDominio, operación que puede tardar unos minutos.

    API Settings

    Una vez finalizada la sincronización inicial puedes empezar a usar el módulo. Selecciona cualquier opción en el menú de la izquierda para empezar.

    Si más adelante deseas modificar el usuario o la contraseña de la API de DonDominio que has proporcionado en este punto, puedes hacerlo desde la pantalla de configuración.

    2.2 Desinstalación

    Para desactivar el módulo, y eliminar todos sus datos almacenados, accede a Ajustes > Módulos extra. Localiza en la lista el módulo DonDominio Manager y pulsa sobre el botón Desactivar. Si la operación se completa correctamente, el módulo será desactivado y todos los datos guardados eliminados.

    Para eliminar el addon completamente de tu instalación de WHMCS, debes ir a /path/to/whmcs/modules/addons, y borrar la carpeta llamada dondominio

    Eliminar o desactivar el módulo no afecta a los TLDs o dominios creados, importados y sincronizados usándolo. Todos los cambios realizados por el módulo en tu instalación de WHMCS permanecerán.

    2.3 Soporte multi-idioma

    El módulo está actualmente disponible en inglés y español. El idioma en que aparecerán los textos depende del idioma de tu panel de administración de WHMCS. Para más información sobre el sistema multi-idioma de WHMCS, consulta la documentación de WHMCS al respecto.

    3 Pagina de inicio

    Esta es la página de inicio a la que accedemos al entrar en el Módulo de DonDominio.

    El propósito de esta sección es el de informar de si han sucedido problemas relacionados con el Módulo y la de ofrecer los enlaces para consultar la documentación del Módulo y su repositorio en GitHub.

    Home

    4 Estado de los módulos

    El módulo Estado se encuentran en la sección de administración Administración > Estado y tiene el propósito de informar sobre el estado y la información de los distintos componentes relevantes para el funcionamiento del Registrador y Addon de DonDominio.

    La información proporcionada es: la versión de WHMCS, la versión y estado de los Modulos, el estado del SDK, el estado de la conexión con la API y el estado de los Dominios prémium.

    También se pueden realizar las siguientes acciones: Consultar el estado de la API, configurar los Dominios prémium y activar y configurar el Registrador.

    Los botones de Más Información y PHP Info muestran más información sobre la configuración del sistema.

    Status

    5 Configuración

    El módulo Configuración se encuentra dentro de la seccion de Administración Administración > Configuración y nos permite configurar diferentes aspectos y funcionalidades del módulo de DonDominio para WHMCS.

    La configuración está dividida en pestañas para facilitar su uso.

    5.1 API de DonDominio

    API

    Campo Valores Descripción
    Usuario de API Texto Tu nombre de usuario de la API de DonDominio
    Contraseña de API Texto Tu contraseña de la API de DonDominio

    5.2 Ajuste de precios

    Price

    Campo Valores Descripción
    Actualizar precios en WHMCS cuando cambien Sí/No Cuando haya un cambio de precios en DonDominio, cambiarlos también en las tarifas de los TLDs configurados en WHMCS
    Aumento de registro Número Cantidad (fija o en %) a añadir a los precios de registro que se recogen de la API de DonDominio
    Aumento de transferencia Número Cantidad (fija o en %) a añadir a los precios de transferencia que se recogen de la API de DonDominio
    Aumento de renovación Número Cantidad (fija o en %) a añadir a los precios de renovación que se recogen de la API de DonDominio

    5.3 Notificaciones automáticas

    Notifications

    Campo Valores Descripción
    Activar notificaciones Sí/No Activa o desactiva las notificaciones del módulo de forma global
    Correo para notificaciones Email La dirección de correo electrónico a la que se enviarán las notificaciones. Si se deja en blanco, no se enviarán notificaciones.
    Notificaciones activadas N/A Los diferentes tipos de notificaciones disponibles. Activa aquellas para las que quieras recibir notificaciones.
    Lista de seguimiento/ignorados N/A Funcionalidad de lista de seguimiento/ignorados.

    Para usar la función de Lista de seguimiento/ignorados, primero selecciona un modo de los 3 disponibles:

    • No usar la lista de seguimiento/ignorados: La lista no se usará para las notificaciones.
    • Seguir sólo estos TLDs: Sólo se enviarán notificaciones para los TLDs seleccionados.
    • Ignorar estos TLDs: Se enviarán notificaciones para todos los TLDs excepto los seleccionados.

    Luego, selecciona uno o más TLDs de la lista a la izquierda (TLDs disponibles) y pulsa >> para moverlos a la lista de la derecha (TLDs seleccionados). Para eliminar un TLD de la lista seleccionalo en la lista de la derecha y pulsa << para devolverlo a la lista de la izquierda.

    5.4 Estado de caché

    Cache

    Este módulo guarda en la base de datos una copia local (caché) de las tarifas de TLDs descargadas de la API de DonDominio. Esta pantalla muestra información sobre la misma.

    • Última actualización: Fecha de la última vez que se han descargado las tarifas desde la API de DonDominio.
    • TLDs en caché: Número de TLDs soportados por la API de DonDominio.
    • Reconstruir la caché: Selecciona esta casilla y pulsa Guardar cambios para vaciar la caché y volver a descargar todas las tarifas desde la API de DonDominio. Este proceso puede tardar algunos minutos.

    5.5 Proxy de Whois

    Whois

    • Dominio de WHMCS: La URL que conduce a tu frontend de WHMCS
    • Direcciones IP permitidas: Una o más direcciones IP, separadas por un punto y coma, que pueden acceder al Proxy de Whois

    6 Saldo

    El módulo Saldo se encuentran en la sección de administración Administración > Saldo y tiene el propósito de informar sobre el el saldo que queda en el usuario API configurado y el umbral de aviso.

    Balance

    7 Actualizar tarifas

    El módulo Actualizar tarifas se encuentra dentro de la sección de TLDs y Tarifas TLDs y Tarifas > Actualizar tarifas y nos permite actualizar los precios de los TLDs configurados en WHMCS directamente desde la API de DonDominio.

    TLDs Pricing

    7.1 Actualización de precios

    Para usar la función de Actualización de precios, primero selecciona todos los TLDs que deseas actualizar y luego pulsa el botón Actualizar precios. El módulo aplicará a todos los TLDs seleccionados los últimos precios recogidos desde la API de DonDominio, teniendo en cuenta incrementos configurados en la pantalla de configuración.

    7.2  Cambio de registrador

    Nota
    Para que el módulo pueda actualizar los precios de los TLDs estos deben estar configurados para funcionar con el módulo de registro de DonDominio.

    Para que el módulo pueda actualizar y gestionar los TLDs configurados en tu instalación de WHMCS, estos deben estar configurados para funcionar con el módulo de registro de DonDominio. Seleccionar todos los dominios que quieras configurar y pulsar el botón Cambiar registrador a DonDominio los configurará de forma automática para que funcionen de esta forma.

    Nota
    Si los TLDs seleccionados estaban configurados para funcionar con otro módulo de registro, este cambio hará que dejen de funcionar con el mismo. Asegúrate de que esto no causará problemas a la hora de registrar nuevos dominios en tu sistema.

    7.3 Cambio manual de precios

    Desde la lista de TLDs es posible modificar los precios de forma manual. Pulsa sobre el icono Editar en un TLD para abrir las opciones de precios personalizados.

    Desde la pantalla que aparecerá, tienes diversas opciones:

    No actualizar de forma automática el precio de este TLD
    Si esta opción está activada la actualización automática de precios ignorará este TLD.

    Activar la configuración individual
    Si esta opción está activada se aplicarán los precios configurados en esta pantalla. En caso contrario, se aplicarán los incrementos de tarifas globales.

    Aumento de registro
    Aumento de precio a aplicar al precio de registro de este TLD. El precio de registro se obtiene desde la API de DonDominio, y puedes escoger aplicar un aumento Fijo (sumando una cantidad concreta al precio de DonDominio) o % (añadiendo un tanto porciento al precio de DonDominio), o bien Desactivarlo y en cambio fijarlo a una cantidad concreta (ignorando los precios de DonDominio).

    Aumento de transferencia y Aumento de renovación
    Ambas opciones funcionan exactamente igual que el Aumento de registro, pero para transferencias y renovaciones respectivamente.

    Para guardar la configuración, pulsa Guardar cambios.

    Cuando las tarifas de los TLDs se actualicen (ya sea automáticamente o manualmente) se aplicará la configuración que hayas establecido en esta pantalla para este TLD.

    Manual TLD Pricing

    8 TLDs disponibles

    El módulo TLDs disponibles se encuentra dentro de la sección de TLDs y Tarifas TLDs y Tarifas > TLDs disponibles y nos permite añadir a tu instalación de WHMCS nuevos TLDs que la API de DonDominio soporta pero aún no están configurados para que tus clientes puedan contratarlos.

    Al crear un nuevo TLD se le asignarán los precios más recientes recogidos desde la API de DonDominio y se configurará para usar automáticamente el módulo de registro de DonDominio.

    Available TLDs

    8.1 Filtros (TLDs disponibles)

    Este módulo dispone de filtros para buscar TLDs en la lista, se puede filtrar por todo o parte de un TLD para filtrar la lista por el mismo.

    8.2 Añadir TLDs

    Selecciona uno o más TLDs que quieras añadir a tu instalación de WHMCS y pulsa el botón Añadir a WHMCS para crearlos de forma automática. Los TLDs añadidos tendrán la tabla de precios obtenida desde la API de DonDominio y estarán configurados por defecto para usar el módulo de registro de DonDominio.

    Una vez añadidos, los TLDs estarán disponibles para que tus usuarios puedan seleccionarlos al registrar y transferir dominios.

    Alternativamente, puedes hacer clic en el icono Añadir de un TLD para añadirlo directamente.

    9 Gestión de dominios

    El módulo Gestión se encuentra dentro de la sección de Gestión de dominios Gestión de dominios > Gestión y nos permite comprobar y actualizar la información de los dominios existentes en tu instalación de WHMCS. También te permitirá configurar los dominios existentes para que funcionen usando el módulo de registro de DonDominio.

    Domains

    9.1 Filtros (Dominios)

    Este módulo dispone de filtros para buscar dominios en la lista, nos permite filtrar por los siguientes campos: Nombre de dominio, TLD, Registrador y Estado.

    9.2 Cambiar registrador

    Selecciona uno o más dominios de la lista y pulsa el botón Cambiar registrador a DonDominio para configurar esos dominios para usar el módulo de registro de DonDominio.

    9.3 Actualizar datos

    Nota
    Para que el módulo pueda actualizar los datos de un dominio éste debe estar configurado antes para usar el módulo de registro de DonDominio.

    Selecciona uno o más dominios de la lista y pulsa el botón Actualizar datos desde DonDominio para actualizar los datos del dominio según los datos disponibles en la API de DonDominio. Los datos que se actualizarán son el estado del dominio y su fecha de expiración.

    Alternativamente, puedes hacer clic en el icono Sincronizar de un dominio para actualizar su información directamente.

    9.4 Contactos

    Puedes cambiar los contactos de los dominios de forma masiva desde esta pantalla también, usando un ID de contacto de DonDominio.

    IDs de contacto de DonDominio
    Los IDs de contacto de DonDominio son códigos especiales que identifican a los contactos de dominios dentro del sistema de DonDominio. Tienen un formato parecido a AAA-00000 y se encuentran en el panel de administración de DonDominio.

    Para ver todos tus IDs de contacto, accede a tu panel de administración de DonDominio en https://www.dondominio.com y luego haz clic sobre el menú Admin arriba a la izquierda, luego sobre Herramientas y finalmente sobre Contactos. En la lista que aparecerá, encontrarás los IDs bajo la columna Contacto ID. Ese es el código que debes proporcionar en el campo correspondiente para que la actualización de contactos funcione.

    Selecciona uno o más dominios que quieras modificar, introduce el ID de contacto obtenido desde tu panel de DonDominio en el campo ID de contacto de DonDominio y luego pulsa sobre una de los siguientes botones:

    • Actualizar contacto propietario: Modificará el propietario del dominio usando el ID de contacto proporcionado.
    • Actualizar contacto administrativo: Modificará el contacto administrativo del dominio usando el ID de contacto proporcionado.
    • Actualizar contacto técnico: Modificará el contacto técnico del dominio usando el ID de contacto proporcionado.
    • Actualizar contacto de pago: Modificará el contacto de pago del dominio usando el ID de contacto proporcionado.

    Nota
    La actualización de contactos puede tardar varios minutos cuando se aplica a varios dominios a la vez.

    9.5 Transferir a DonDominio

    A través del botón de Transferir que se encuentra en los dominios que no tienen como registrador a DonDominio se puede transferir el dominio a DonDominio indicando el Authcode/EPP

    9.6 Dominio

    Desde la lista de la Gestión de dominios se puede acceder a un dominio en concreto, esta vista ofrece la posibilidad de sincronizar el estado del dominio y consulta su información e historial a la API de DonDominio.

    Domain

    10 Transferir dominios

    El módulo Transferir se encuentran en la sección de Gestión de dominios Gestión de dominios > Transferir y nos permite transferir de forma masiva dominios a DonDominio.

    Transfer

    11 Importar dominios

    El módulo Importar se encuentra dentro de la sección de Gestión de dominios Gestión de dominios > Importar y nos permite importar a tu instalación de WHMCS los dominios en tu cuenta de DonDominio que aún no existan en WHMCS. Los dominios se copiarán con la misma información que esté disponible en ese momento en la API de DonDominio y se asignarán al cliente de tu elección.

    Nota A la hora de importar dominios, se creará un nuevo pedido en WHMCS con los dominios importados relacionados.

    A la derecha de cada dominio encontrarás un indicador de su estado. NO IMPORTADO significa que el dominio existe en tu cuenta de DonDominio pero no en tu instalación de WHMCS. En cambio, el indicador IMPORTADO indica que ese dominio ya existe en WHMCS (y, por tanto, no puede ser importado de nuevo).

    Para actualizar la información de los dominios ya existentes en WHMCS, consulta la sección de Gestión de dominios.

    Import

    11.1 Filtros (Importar dominios)

    Este módulo dispone de filtros para buscar dominios en la lista, se puede filtrar por: Nombre de dominio y TLD.

    11.2 Importar

    Selecciona uno o más dominios de la lista, selecciona un cliente del desplegable y pulsa el botón Importar a WHMCS y asignar al cliente seleccionado. Los dominios se copiarán a tu instalación de WHMCS como si el cliente seleccionado los hubiese registrado o transferido de forma manual. Los dominios existentes en tu instalación de WHMCS se ignorarán.

    12 Dominios Borrados

    El módulo Borrados se encuentran en la sección de Gestión de dominios Gestión de dominios > Borrados y nos permite listar todos los dominios borrados del usuario API configurado.

    Deleted Domains

    13 Gestión de contactos

    El módulo Contactos se encuentran en la sección de Gestión de dominios Gestión de dominios > Contactos y no permite listar los contactos de el usuario API configurado.

    Contacts

    13.1 Filtros (Contactos)

    Este módulo dispone de filtros para buscar contactos en la lista, nos permite filtrar por los siguientes campos: Nombre, Correo, verificación y Designated Agent.

    13.2 Contacto

    Desde la lista de la Contactos se puede acceder a un contacto en concreto, esta vista ofrece informacion mas detallada de el contacto y la posibilidad de reenviar el correo de verificación.

    Contact

    14 Whois

    Esta característica consta de dos partes que permiten configurar de forma sencilla un proxy local para realizar las comprobaciones de disponibilidad de dominios desde WHMCS (también conocido como "Whois lookup").

    14.1 Configuración (Whois)

    El proxy de whois se puede configurar tanto en la sección de Proxy Whois Proxy Whois > Configuración o en la sección de Administración Administración > Configuración > Proxy de Whois.

    • Dominio de WHMCS: El dominio donde está alojado WHMCS.
    • Dirección IP permitida: Listado de IP's permitidas para realizar búsquedas WHOIS. Lease la sección Control de acceso.

    Whois Configuration

    Por último, para configurar cada TLD para utilizar con el whois proxy, se debe acceder al menú lateral izquierda Proxy de Whois.

    Haz clic en el botón Cambiar a DonDominio (siguiente imagen) para configurar cada TLD de forma automática. Se modificará el fichero whois.js (o whoisservers.php en WHMCS 6) para que a partir de ese momento las consultas de disponibilidad de ese TLD se realicen a través de la API. No necesitas hacer ningún cambio más.

    Whois

    Permisos

    Si apareciese un mensaje informándote de que el servidor no puede escribir el fichero whois.json (o whoisservers.php en WHMCS 6), necesitarás cambiar los permisos de este fichero de forma que el servidor web pueda escribir en él, o realizar los cambios manualmente en el fichero.

    Control de acceso
    Debido al gran número de consultas que suelen recibir los servicios de comprobación de disponibilidad de dominios y a que el número de consultas a través de la API de DonDominio está limitado, te recomendamos usar los filtros de IP de la configuración o proteger de cualquier otra forma el acceso al proxy de Whois para evitar un acceso indebido.

    Copias de seguridad El módulo incorpora una opción para hacer copias de seguridad de tu fichero de servidores de Whois. Recomendamos encarecidamente realizar una copia de tu fichero antes de realizar cualquier cambio. Una mala configuración o error en este fichero provocará que WHMCS sea incapaz de registrar o transferir cualquier dominio que pertenezca al TLD afectado. Así mismo, es conveniente realizar limpiezas periódicas de estas copias de seguridad.

    14.2 Configuración manual en WHMCS 6

    Si, por cualquier motivo, no puedes usar la configuración automática de servidores Whois (por ejemplo, por problemas de permisos en los ficheros), puedes realizar los cambios manualmente.

    El único dato que necesitas conocer es la URL de acceso a tu servidor WHMCS. Accede a tu servidor web y navega hasta el fichero /path/to/whmcs/includes/whoisservers.php y edita el fichero con tu editor preferido.

    Dentro del fichero, busca el TLD que quieres configurar. Encontrarás una línea parecida a esta:

    .me.uk|whois.nic.uk|No match

    Modifícala de la siguiente manera:

    .me.uk|http://www.yourwhmcsdomain.com/modules/addons/dondominio/whois/whoisproxy.php?domain=|DDAVAILABLE

    Donde http://www.yourwhmcsdomain.com/ es tu dominio de acceso a WHMCS. Puedes realizar este cambio en tantos TLDs como necesites.

    14.3 Configuración manual en WHMCS 7

    El fichero en WHMCS 7 para los servidores de whois ha sido cambiado a un fichero JSON y se encuentra en un directorio distinto a su contrapartida en WHMCS 6.

    Lo encontrarás en /path/to/whmcs/resources/domains/ con el nombre whois.json.

    Si quieres configurar manualmente un servidor de whois en este fichero deberás encontrar el registro adecuado para el TLD que quieres modificar y ajustarlo.

    Un registro en el fichero tiene este aspecto:

    [
    ...
    {
        "extensions": ".com,.net,.es,.com.es,.nom.es,.gob.es,.edu.es",
        "uri": "socket://whois.crsnic.net",
        "available": "No match for"
    },
    ...
    ]

    Debes ajustar los parámetros "uri" y "available" de la siguiente manera:

    [
    ...
    {
        "extensions": ".com,.net,.es,.com.es,.nom.es,.gob.es,.edu.es",
        "uri": "http://www.yourwhmcsdomain.com/modules/addons/dondominio/whois/whoisproxy.php?domain=",
        "available": "DDAVAILABLE"
    },
    ...
    ]

    Donde http://www.yourwhmcsdomain.com/ es tu dominio de acceso a WHMCS. Puedes realizar este cambio en tantos TLDs como necesites.

    14.4 Uso

    Para realizar búsquedas de WHOIS se debe acceder al menú superior Utilidades > Herramienta WHOIS.