Eximus Platform Documentation

Welcome to the Eximus documentation. This guide will help you understand and utilize all features of our advanced traffic protection and campaign management platform.

Note: Eximus provides automatic antibot protection on all campaign links and short URLs. No additional configuration is required - protection is active from the moment you create a link.

Quick Start Guide

Follow these steps to get started with Eximus:

1

Create Your Account

Register for a new account and receive a 2-day free trial automatically.

2

Choose a Subscription Plan

Select from Standard, Business, or Enterprise plans based on your needs.

3

Create Your First Campaign

Set up a campaign link with your target URL and protection settings.

4

Monitor Performance

Track your traffic, conversions, and blocked threats in real-time.

AntiBot SDK Overview

The Eximus AntiBot SDK is a standalone PHP-based bot detection system that provides advanced fingerprinting and traffic protection for any website. It works independently from campaign links, allowing you to protect any PHP application.

Standalone Protection: The AntiBot SDK can be integrated into any PHP website to add enterprise-grade bot detection, regardless of whether you're using Eximus campaign links.

Key Features

Browser Fingerprinting

Advanced JavaScript fingerprinting collects 50+ browser attributes for accurate bot detection.

Real-time Bot Detection

Instant bot/human classification using Eximus cloud intelligence.

Analytics Dashboard

Beautiful statistics interface to monitor all visitor activity and bot patterns.

IP Intelligence

Detailed visitor data including location, ISP, ASN, and timezone information.

Easy Integration

Single line integration - just include the PHP file in your pages.

Automatic Logging

All visitor data automatically logged to JSON for analysis and export.

AntiBot SDK Installation

Follow these steps to install and configure the AntiBot SDK on your website:

1

Download the SDK

Download the AntiBot SDK package from your Eximus dashboard under Services → AntiBot SDK.

2

Extract Files

Extract the package to your web server. You'll get:

  • antibot.php - Main detection script
  • stats.php - Analytics dashboard
  • README.txt - Quick reference guide
3

Get Your License Key

Find your AntiBot license key in your Profile or Download page.

4

Configure License

Open antibot.php and add your license key on line 13:

$EXIMUS_LICENSE_KEY = 'YOUR_LICENSE_KEY_HERE';

Configuration Options

The AntiBot SDK provides several configuration options in the antibot.php file:

// Configuration Section $EXIMUS_LICENSE_KEY = 'YOUR_LICENSE_KEY_HERE'; // Your license key $ENABLE_LOGGING = true; // Enable/disable logging $LOG_FILE = __DIR__ . '/visitors.json'; // Log file location

Configuration Parameters

Parameter Type Default Description
$EXIMUS_LICENSE_KEY String Required Your Eximus license key
$ENABLE_LOGGING Boolean true Enable visitor logging to JSON file
$LOG_FILE String visitors.json Path to the log file

Integration Guide

Basic Integration

Add the AntiBot SDK to any PHP page with a single line:

<?php require_once 'antibot.php'; ?> <!-- Your HTML content --> <html> <head> <title>Protected Page</title> </head> <body> <h1>This page is protected by Eximus AntiBot</h1> </body> </html>

Custom Bot/Human Actions

Customize what happens when bots or humans are detected by editing lines 103-114 in antibot.php:

if ($detection) { if (!$detection['ok']) { // BOT DETECTED - Customize action header('Location: https://google.com'); // Redirect to Google exit; } else { // HUMAN DETECTED - Show protected content include('protected-content.php'); exit; } }

Accessing Detection Data

The $detection array provides comprehensive visitor information:

$detection = eximus_antibot(); // Available data: $detection['ok'] // true for human, false for bot $detection['ip'] // Visitor IP address $detection['country'] // Country code (US, GB, etc.) $detection['country_name'] // Full country name $detection['city'] // City name $detection['isp'] // Internet Service Provider $detection['org'] // Organization $detection['asn'] // Autonomous System Number $detection['timezone'] // Visitor timezone $detection['action'] // HTTP status (200, 403, etc.) $detection['target'] // Detection target type

Advanced Integration Examples

WordPress Integration

// Add to wp-config.php or theme functions.php require_once(ABSPATH . 'antibot/antibot.php'); // For specific pages only function protect_sensitive_pages() { if (is_page('checkout') || is_page('register')) { $detection = eximus_antibot(); if ($detection && !$detection['ok']) { wp_die('Access Denied - Bot Detected'); } } } add_action('template_redirect', 'protect_sensitive_pages');

Session-Based Protection

session_start(); $detection = eximus_antibot(); if ($detection) { if ($detection['ok']) { // Human verified - set session $_SESSION['verified_human'] = true; $_SESSION['user_country'] = $detection['country']; $_SESSION['user_city'] = $detection['city']; } else { // Bot detected - destroy session session_destroy(); die('Access Denied'); } }

API Endpoint Protection

// Protect API endpoints require_once 'antibot.php'; $detection = eximus_antibot(); if (!$detection || !$detection['ok']) { http_response_code(403); die(json_encode(['error' => 'Forbidden'])); } // Continue with API logic...

Statistics Dashboard

The AntiBot SDK includes a comprehensive analytics dashboard to monitor all visitor activity.

Accessing the Dashboard

Navigate to stats.php on your website:

https://yourwebsite.com/path/to/stats.php

Dashboard Features

Real-time Statistics

Live counters for total visitors, humans detected, and bots blocked.

Visitor Log

Detailed table showing all visitors with IP, location, ISP, and status.

Export Data

Export all visitor logs as JSON for external analysis.

Auto-refresh

Dashboard automatically refreshes every 30 seconds for live monitoring.

Securing the Dashboard

Protect your stats dashboard with password authentication:

// Add to top of stats.php session_start(); $password = 'your_secure_password'; if ($_POST['password'] !== $password && !$_SESSION['auth']) { die('<form method="post"> Password: <input type="password" name="password"> <button>Login</button> </form>'); } $_SESSION['auth'] = true;

Customization Options

Custom Actions for Bots

Redirect Strategy

// Redirect to search engine header('Location: https://google.com'); exit;

Blank Page

// Show blank page header('HTTP/1.0 403 Forbidden'); die();

Custom Error

// Custom error page include('error_403.html'); exit;

Log & Block

// Log to database then block log_bot_attempt($detection); die('Access Denied');

Custom Actions for Humans

  • Set session variables for authenticated humans
  • Pre-fill forms with location data
  • Show personalized content based on country
  • Track conversion with enhanced data

API Reference

Main Function

function eximus_antibot() Returns: Array|null - Returns detection array on POST request with fingerprint data - Returns null on initial page load (while collecting fingerprint)

Response Structure

{ "ok": true, // true = human, false = bot "ip": "192.168.1.1", // Visitor IP "country": "US", // Country code "country_name": "United States", "city": "New York", "isp": "ISP Name", "org": "Organization", "asn": 12345, // ASN number "timezone": "America/New_York", "cid": "correlation_id", "target": "human|bot", "action": "200|403|404", // HTTP status "data": {} // Full API response }

Log File Format

Visitor data is logged to visitors.json in the following format:

{ "timestamp": "2025-01-20 15:30:45", "ip": "192.168.1.1", "country": "US", "country_name": "United States", "city": "New York", "isp": "ISP Name", "org": "Organization", "asn": 12345, "timezone": "America/New_York", "user_agent": "Mozilla/5.0...", "referer": "https://example.com", "status": "HUMAN|BOT", "action": "200", "target": "human" }
Note: Logs automatically rotate after 1000 entries to prevent excessive file sizes. Export important data regularly if you need long-term storage.

Requirements

  • PHP Version: 7.0 or higher
  • PHP Extensions: cURL, JSON
  • File Permissions: Write access for log file
  • License: Valid Eximus AntiBot license

Troubleshooting

Issue Possible Cause Solution
No detection happening Invalid license key Verify license key in Profile page
Logs not saving File permissions Ensure directory has write permissions
Stats page blank No visitor data yet Wait for first visitors or test manually
Always detecting as bot JavaScript disabled Ensure JavaScript is enabled in browser
cURL errors cURL not enabled Enable cURL in PHP configuration
Pro Tip: Test your AntiBot integration using different browsers and VPNs to ensure it's correctly identifying bots and humans. Monitor the stats dashboard regularly to identify patterns and optimize your protection rules.

Creating Campaign Links

Campaign links are the core of Eximus's protection system. Each campaign link acts as a protected gateway to your actual destination URL.

Step-by-Step Campaign Creation

1

Navigate to Campaign Creation

Go to Services → Campaign → Create Campaign in your dashboard.

2

Enter Original Link

Input your destination URL where legitimate traffic will be redirected.

3

Set Bot Link (Optional)

Specify where bot traffic should be redirected. Leave empty to show a blank page to bots.

4

Configure Protection Settings

Choose country restrictions, enable/disable redirect, and set other filters.

Campaign Settings Explained

Redirect Link

Your protected campaign URL that you'll use in your advertising campaigns.

Original Link

The destination URL where real human visitors will be sent.

Bot Link

Alternative destination for detected bot traffic (optional).

Country Allowed

Restrict access to specific countries using country codes (e.g., US, GB, CA).

Redirect Enabled

Toggle to enable/disable the campaign without deleting it.

HTML Content

Optional HTML page to display instead of redirect (cloaking page).

Campaign Link Customization

Eximus provides powerful customization options for your campaign links, allowing you to create fully branded and customized landing pages that maintain your campaign's look and feel.

Accessing Customization Options

Navigate to Services → Campaign → Customization to access the visual landing page designer.

Full Design Control: Every aspect of your campaign landing page is customizable - from colors and fonts to layout and content.

Customizable Elements

Colors & Branding

Customize primary colors, secondary colors, backgrounds, and gradients to match your brand identity.

Typography

Choose fonts, sizes, weights, and text colors for headings, body text, and buttons.

Images & Media

Upload logos, background images, icons, and other media assets directly to your landing page.

Layout Options

Select from multiple layout templates or create custom arrangements for your content.

Custom HTML/CSS

Add custom HTML sections and CSS for advanced customization needs.

Responsive Design

All customizations are automatically responsive for perfect display on all devices.

Landing Page Components

Build your landing page using these customizable components:

  • Header Section: Logo, navigation menu, call-to-action buttons
  • Hero Banner: Main headline, subheadline, background image/video
  • Content Blocks: Text sections, feature lists, testimonials
  • Media Elements: Image galleries, video players, animations
  • Forms: Contact forms, email capture, custom fields
  • Footer: Links, copyright, social media icons

Customization Workflow

1

Select Campaign

Choose which campaign link you want to customize from your campaigns list.

2

Choose Template

Start with a pre-designed template or begin with a blank canvas.

3

Customize Design

Use the visual editor to modify colors, fonts, images, and layout.

4

Preview & Test

Preview your design on different devices and test all functionality.

5

Publish Changes

Save and publish your customized landing page instantly.

Advanced Customization Features

Dynamic Content

Use dynamic placeholders to personalize content based on visitor data:

{{country}} - Visitor's country {{city}} - Visitor's city {{device}} - Device type {{browser}} - Browser name {{parameter}} - URL parameter value

A/B Testing

Create multiple versions of your landing page to test different designs:

  • Test different headlines and copy
  • Compare button colors and placements
  • Experiment with layouts and images
  • Track conversion rates for each version

Custom Scripts

Add tracking pixels, analytics codes, or custom JavaScript:

  • Facebook Pixel integration
  • Google Analytics tracking
  • Custom conversion tracking
  • Third-party widgets and tools
Pro Tip: Save your customized designs as templates for quick reuse across multiple campaigns.

Best Practices for Landing Page Design

  1. Keep It Simple: Focus on one clear message and call-to-action
  2. Fast Loading: Optimize images and minimize external resources
  3. Mobile First: Design for mobile devices first, then enhance for desktop
  4. Clear CTA: Make your call-to-action buttons prominent and compelling
  5. Trust Elements: Include testimonials, badges, or security icons
  6. Consistent Branding: Match your landing page to your main website or offer

Performance Optimization

Eximus automatically optimizes your customized landing pages for performance:

  • Image Compression: Automatically compresses uploaded images
  • CDN Delivery: Serves assets from global CDN locations
  • Code Minification: Minifies HTML, CSS, and JavaScript
  • Lazy Loading: Loads images and content as needed
  • Browser Caching: Optimizes cache headers for repeat visitors

Automatic Parameter Passing

Eximus automatically transfers all GET parameters from your campaign link to the destination URL. This powerful feature ensures tracking parameters, UTM codes, email addresses, and other data pass through seamlessly.

Automatic Parameter Transfer: All parameters added to your campaign link are automatically appended to your redirect URL, including email addresses and user data.

How Parameter Passing Works

Campaign Link
yourdomain.com/[email protected]
Eximus Protection

Bot filtering & validation

Destination URL
destination.com/[email protected]

Email Capture via Parameters

One of the most powerful uses of parameter passing is automatic email capture. When email addresses are passed as URL parameters, they flow through to your destination, allowing seamless data collection.

Common Parameter Use Cases

UTM Tracking

?utm_source=google
&utm_medium=cpc
&utm_campaign=summer2025

Track campaign performance across all platforms

Email & User Data

[email protected]
&name=John+Doe
&phone=1234567890

Pass user information for pre-filling forms

Click IDs

?gclid=abc123xyz
&fbclid=def456uvw
&msclkid=ghi789rst

Maintain platform-specific tracking identifiers

Affiliate Tracking

?aff_id=partner123
&sub_id=campaign456
&source=newsletter

Track affiliate partners and sub-campaigns

Advanced Email Capture Strategies

Pre-lander Email Collection

1
Pre-lander Page

Collect email on your campaign link using HTML content

2
Process & Redirect

JavaScript captures email and adds to redirect URL

3
Main Offer

Email automatically fills form on destination

// Example: JavaScript for email capture and redirect function redirectWithEmail() { const email = document.getElementById('email').value; const destination = 'https://destination.com/offer'; // Add email to URL parameters window.location.href = destination + '?email=' + encodeURIComponent(email); }

Parameter Security Best Practices

Security Note: When passing sensitive data like emails through URL parameters, ensure your destination pages use HTTPS and proper data handling practices.
  • URL Encoding: Always encode special characters in email addresses and other data
  • HTTPS Only: Use secure connections for pages handling email data
  • Validation: Validate email formats on both collection and destination pages
  • Privacy Compliance: Ensure GDPR/privacy compliance when collecting emails

Using HTML Pages (Cloaking)

Instead of immediate redirects, you can display custom HTML content on your campaign links. This is useful for creating safe pages, pre-landers, or implementing advanced cloaking strategies.

Setting Up HTML Content

  1. In campaign creation/edit, locate the "HTML Content" field
  2. Paste your complete HTML code (including <html>, <head>, and <body> tags)
  3. Save the campaign
  4. The HTML page will display instead of redirecting
Important: When using HTML content, automatic redirects are disabled. You must implement your own redirect logic within the HTML if needed.

HTML Page Best Practices

  • Keep pages lightweight for fast loading
  • Use absolute URLs for all resources
  • Include proper meta tags for SEO
  • Test thoroughly before deploying
  • Consider mobile responsiveness

The short link system provides an additional layer of protection with simplified URLs. Short links are perfect for social media, SMS campaigns, and anywhere you need concise URLs.

Short Links vs Campaign Links

Feature Campaign Links Short Links
URL Format Standard URL path Shortened format
Customization Full HTML support Redirect only
Bot Protection ✓ Full protection ✓ Full protection
Parameter Passing ✓ Automatic ✓ Automatic
Analytics ✓ Detailed ✓ Detailed
Best For Display ads, search ads Social media, SMS
1

Access Link Shortener

Navigate to Services → Link Shortener in your dashboard.

2

Enter Original URL

Input the destination URL you want to protect and shorten.

3

Configure Settings

Select bot handling method and country restrictions if needed.

4

Generate Link

Click create to generate your protected short link.

Buying Domains

Eximus offers a curated selection of domains for your campaigns. Having your own domain improves trust and campaign performance.

How to Purchase a Domain

  1. Go to Host → Buy Domain
  2. Browse available domains
  3. Check domain price and availability
  4. Click "Buy Now" on your chosen domain
  5. Confirm purchase (deducted from account balance)
  6. Domain is instantly assigned to your account
Note: Domain purchases are separate from subscription fees. Ensure sufficient account balance before purchasing.

Domain Setup & Configuration

After purchasing a domain, it's automatically configured for use with your campaigns. Each domain includes:

  • SSL Certificate: Automatic HTTPS encryption
  • DNS Configuration: Pre-configured for optimal performance
  • Server Assignment: Hosted on high-performance servers
  • Instant Activation: Ready to use immediately

Deploy Index Feature

The Deploy Index feature allows you to set a default landing page for your domain root. This is what visitors see when they access your domain directly without a specific campaign path.

Using Deploy Index

  1. Navigate to your domains list
  2. Click "Deploy Index" on your domain
  3. Choose from:
    • Default Page: Professional coming soon page
    • Custom HTML: Upload your own index page
    • Redirect: Send root traffic to another URL
  4. Save changes

Benefits of Deploy Index

Legitimacy

Makes your domain appear more legitimate to reviewers and checkers.

Professional Appearance

Shows a professional page instead of errors when accessed directly.

IP & ASN Management

Control access to your campaigns with advanced IP filtering and ASN-level blocking.

IP Management Features

  • Blacklist IPs: Block specific IP addresses or ranges
  • Whitelist IPs: Allow only specific IPs to access
  • ASN Blocking: Block entire networks by ASN
  • Network Blocks: Block IP ranges using CIDR notation
Example IP Formats: Single IP: 192.168.1.1 IP Range: 192.168.1.0/24 ASN: AS15169 (Google)

Geo-targeting Configuration

Restrict campaign access based on visitor location using country codes.

Setting Country Restrictions

  1. In campaign settings, find "Country Allowed" field
  2. Enter country codes separated by commas
  3. Use standard ISO country codes (US, GB, DE, etc.)
  4. Leave empty to allow all countries
Country Code Example Usage
United States US US
United Kingdom GB GB
Multiple Countries Various US,GB,CA,AU

Analytics & Reporting

Monitor your campaign performance with comprehensive analytics and reporting tools.

Available Metrics

Traffic Overview

Total visitors, unique visitors, and page views.

Bot Detection

Number of bots blocked and bot vs human ratio.

Geographic Data

Visitor locations, countries, and cities.

Device Information

Device types, browsers, and operating systems.

ISP Details

Internet service providers and connection types.

Time Analytics

Traffic patterns by hour, day, and month.

Data Retention

All analytics data is retained for 6 months, allowing you to analyze long-term trends and patterns.

Security Best Practices

Security Recommendations:
  • Regular Password Updates: Change your account password regularly
  • Monitor Analytics: Check for unusual traffic patterns
  • Use Country Restrictions: Limit access to target countries only
  • Enable IP Filtering: Block known problematic IPs
  • Test Campaigns: Always test before launching
  • Keep Domains Clean: Don't use domains for multiple unrelated campaigns

Optimization Tips

Campaign Performance

  1. Use Dedicated Domains: One domain per campaign type for better performance
  2. Optimize HTML Pages: Keep file sizes small for faster loading
  3. Monitor Bot Ratios: High bot traffic may indicate targeting issues
  4. Update Filters Regularly: Adjust country and IP filters based on analytics
  5. Test Different Approaches: A/B test safe pages and redirect strategies

Cost Optimization

  • Choose the right subscription plan for your volume
  • Use short links for high-volume, low-complexity campaigns
  • Implement country restrictions to avoid unwanted traffic
  • Monitor and block bot-heavy traffic sources
Pro Tip: Use the analytics data to identify your best-performing traffic sources and optimize your campaigns accordingly.

Need more help? Contact our support team through the dashboard for assistance with any aspect of the Eximus platform.