Connect WHMCS

Step-by-step guide to connecting your WHMCS installation to MRRlytics via API.

Prerequisites

Before connecting your WHMCS, make sure you have: - Admin access to your WHMCS installation - WHMCS version 8.0 or later - API access enabled in WHMCS (Setup > General Settings > Security > Allow API Access) - A MRRlytics account with an organization set up

Step 1: Create API credentials in WHMCS

In your WHMCS admin panel: 1. Go to Setup > Staff Management > API Credentials 2. Click "Generate New API Credential" 3. Give it a description like "MRRlytics Integration" 4. Set the access permissions. MRRlytics needs read access to: - Clients - Products/Services - Invoices - Domains - Cancellation Requests 5. Copy the API Identifier and API Secret

Step 2: Add the instance in MRRlytics

In your MRRlytics dashboard: 1. Navigate to Settings > Instances 2. Click "Add Instance" 3. Fill in the form: - Name: A friendly name for this WHMCS installation - WHMCS URL: The full URL to your WHMCS admin (e.g., https://billing.example.com) - API Identifier: Paste from WHMCS - API Secret: Paste from WHMCS 4. Click "Save" MRRlytics will validate the connection and confirm it's working.

Step 3: Initial sync

After adding the instance, trigger your first sync by clicking "Sync Now". The initial sync imports: - All active clients and their services - Product catalog and product groups - Invoice history - Domain registrations - Cancellation requests This may take 2-10 minutes depending on your database size.

Sync frequency

MRRlytics syncs your data automatically: - Incremental sync: Every 15 minutes (picks up new changes) - Full sync: Once daily at midnight UTC (recalculates all metrics) You can also trigger a manual sync at any time from the Settings page.

Security

Your WHMCS API credentials are encrypted using AES-256 before being stored. They are never visible in the dashboard after saving. We only access your WHMCS data through the official API with the permissions you granted. All communication uses TLS 1.3 encryption.

Troubleshooting

Common issues: - "Connection failed": Verify your WHMCS URL is correct and accessible from the internet. Make sure API access is enabled in WHMCS settings. - "Authentication error": Double-check your API Identifier and Secret. They are case-sensitive. - "Timeout": If your WHMCS is slow to respond, the sync may time out. Try again or check your WHMCS server performance. - "No data after sync": Ensure your API credentials have the correct read permissions for clients, products, and invoices.