whmcsService.js

Go to the documentation of this file.

/**
 * WHMCS API Service
 * Integrates with WHMCS API to fetch customers, domains, products, etc.
 * 
 * API Documentation: https://developers.whmcs.com/api/
 */
 
const axios = require('axios');
 
/**
 *
 */
class WHMCSService {
  /**
   *
   */
  constructor() {
    this.baseUrl = process.env.WHMCS_URL;
    this.identifier = process.env.WHMCS_IDENTIFIER;
    this.secret = process.env.WHMCS_SECRET;
    
    if (!this.baseUrl || !this.identifier || !this.secret) {
      throw new Error('WHMCS credentials not configured in .env');
    }
  }
 
  /**
   * Make API request to WHMCS
   * @param {string} action - WHMCS API action
   * @param {object} params - Additional parameters
   * @returns {Promise<object>} - API response
   */
  async apiRequest(action, params = {}) {
    try {
      const postData = {
        action,
        identifier: this.identifier,
        secret: this.secret,
        responsetype: 'json',
        ...params
      };
 
      // WHMCS API endpoint is at /includes/api.php relative to admin directory
      const apiUrl = this.baseUrl + '/includes/api.php';
      console.log(`[WHMCS] API Request: ${action} -> ${apiUrl}`);
 
      const response = await axios.post(
        apiUrl,
        new URLSearchParams(postData).toString(),
        {
          headers: {
            'Content-Type': 'application/x-www-form-urlencoded'
          }
        }
      );
 
      if (response.data.result === 'error') {
        throw new Error(response.data.message || 'WHMCS API error');
      }
 
      return response.data;
    } catch (error) {
      console.error(`[WHMCS] API Error (${action}):`, error.message);
      throw error;
    }
  }
 
  /**
   * Get all clients from WHMCS
   * @param {object} options - Filter options
   * @returns {Promise<Array>} - Array of clients
   */
  async getClients(options = {}) {
    const {
      limitstart = 0,
      limitnum = 999999,
      search = '',
      status = '' // Active, Inactive, Closed
    } = options;
 
    const response = await this.apiRequest('GetClients', {
      limitstart,
      limitnum,
      search,
      ...(status && { status })
    });
 
    return response.clients?.client || [];
  }
 
  /**
   * Get detailed information for a specific client
   * @param {number} clientId - WHMCS client ID
   * @returns {Promise<object>} - Client details
   */
  async getClientDetails(clientId) {
    const response = await this.apiRequest('GetClientsDetails', {
      clientid: clientId,
      stats: true
    });
 
    return response;
  }
 
  /**
   * Get all domains from WHMCS
   * @param {object} options - Filter options
   * @returns {Promise<Array>} - Array of domains
   */
  async getDomains(options = {}) {
    const {
      limitstart = 0,
      limitnum = 999999,
      clientid = '',
      domainname = ''
    } = options;
 
    const response = await this.apiRequest('GetClientsDomains', {
      limitstart,
      limitnum,
      ...(clientid && { clientid }),
      ...(domainname && { domainname })
    });
 
    return response.domains?.domain || [];
  }
 
  /**
   * Get all products/services from WHMCS
   * @param {object} options - Filter options
   * @returns {Promise<Array>} - Array of products
   */
  async getProducts(options = {}) {
    const {
      limitstart = 0,
      limitnum = 999999,
      clientid = '',
      serviceid = ''
    } = options;
 
    const response = await this.apiRequest('GetClientsProducts', {
      limitstart,
      limitnum,
      ...(clientid && { clientid }),
      ...(serviceid && { serviceid })
    });
 
    return response.products?.product || [];
  }
 
  /**
   * Get all invoices from WHMCS
   * @param {object} options - Filter options
   * @returns {Promise<Array>} - Array of invoices
   */
  async getInvoices(options = {}) {
    const {
      limitstart = 0,
      limitnum = 999999,
      userid = '',
      status = '' // Unpaid, Paid, Cancelled, Refunded
    } = options;
 
    const response = await this.apiRequest('GetInvoices', {
      limitstart,
      limitnum,
      ...(userid && { userid }),
      ...(status && { status })
    });
 
    return response.invoices?.invoice || [];
  }
 
  /**
   * Get all tickets from WHMCS
   * @param {object} options - Filter options
   * @returns {Promise<Array>} - Array of tickets
   */
  async getTickets(options = {}) {
    const {
      limitstart = 0,
      limitnum = 999999,
      clientid = '',
      status = '' // Open, Answered, Customer-Reply, Closed
    } = options;
 
    const response = await this.apiRequest('GetTickets', {
      limitstart,
      limitnum,
      ...(clientid && { clientid }),
      ...(status && { status })
    });
 
    return response.tickets?.ticket || [];
  }
 
  /**
   * Get custom client fields
   * @returns {Promise<Array>} - Array of custom fields
   */
  async getCustomFields() {
    const response = await this.apiRequest('GetCustomFields', {
      type: 'client'
    });
 
    return response.customfields?.customfield || [];
  }
 
  /**
   * Export all clients with related data
   * @returns {Promise<object>} - Complete export
   */
  async exportAllData() {
    console.log('[WHMCS] Starting full data export...');
    
    const clients = await this.getClients({ status: 'Active' });
    console.log(`[WHMCS] Found ${clients.length} active clients`);
 
    const allDomains = await this.getDomains();
    console.log(`[WHMCS] Found ${allDomains.length} domains`);
 
    const allProducts = await this.getProducts();
    console.log(`[WHMCS] Found ${allProducts.length} products`);
 
    const customFields = await this.getCustomFields();
    console.log(`[WHMCS] Found ${customFields.length} custom fields`);
 
    return {
      clients,
      domains: allDomains,
      products: allProducts,
      customFields,
      exportedAt: new Date().toISOString()
    };
  }
 
  /**
   * Test API connection
   * @returns {Promise<boolean>} - Connection status
   */
  async testConnection() {
    try {
      const response = await this.apiRequest('GetClients', {
        limitnum: 1
      });
      
      console.log('[WHMCS] ✅ API connection successful');
      return true;
    } catch (error) {
      console.error('[WHMCS] ❌ API connection failed:', error.message);
      return false;
    }
  }
}
 
module.exports = WHMCSService;