Scantix Plugin: How to Use Guide

Overview

Scantix is a secure, all-in-one WooCommerce plugin for selling, issuing, and verifying event tickets using unique QR codes. It automates the entire process—from ticket purchase to entry validation—while keeping everything organized within your WordPress admin panel.

This plugin operates as part of the Scantix licensing architecture. The Scantix plugin provides all core ticketing functionality, but its features are enabled only if its license is active and verified by a separate Scantix licensing server installation.

Installation & Setup

To use the Scantix plugin, you will need a **licensed Scantix licensing server installation** (managed by your vendor) and your own WordPress site.

Prerequisites:

  • **License Information:** You will need connection details (URL and Shared Secret) from your Scantix vendor.
  • **Your WordPress site:** Where you will install Scantix.
  • **WooCommerce:** Installed and activated on your WordPress site.
  • **PHP 7.4+:** Ensure your server environment meets WordPress and WooCommerce requirements.
  • **Secure Site (SSL/HTTPS):** Your site should use SSL/HTTPS for secure communication.

Setup Scantix Plugin

  1. Install Scantix:
    • Go to Plugins → Add New → Upload Plugin in your WordPress dashboard.
    • Upload the scantix.zip file.
    • Click Install Now, then Activate.
  2. Configure Licensing Server Connection:
    • Navigate to Scantix → Scantix Settings in the admin menu.
    • Licensing Server URL: Enter the full URL of your vendor’s **licensing server site** (e.g., https://your-licensing-server.com).
    • Shared Secret: Enter the **exact same Shared Secret** that your vendor provided, which is configured on their licensing server.
    • Click Save Changes.
  3. Check License Status:
    • On the Scantix Settings page, click the “Check License Now” button.
    • Expected Result: The “License Status” should update to “ACTIVE” and display the expiry date if the licensing server successfully verified the license. If it shows “INACTIVE or EXPIRED” or an error, double-check your configurations and contact your vendor.
    • Admin Notices: If the license is inactive or expired, an admin notice will appear across the site, prompting for renewal and disabling core functionalities.
  4. Advanced Security Configuration (Highly Recommended):
    • On the Scantix Settings page, navigate to the “Advanced Security Configuration” section.
    • For enhanced security, it is highly recommended to define the Licensing Server URL, Shared Secret, and Encryption Key directly in your wp-config.php file. This prevents these sensitive values from being stored in the database.
    • Add the following lines to your wp-config.php file, preferably above the line that says /* That’s all, stop editing! Happy publishing. */. Replace the placeholder values with the actual Mother Plugin URL, Shared Secret, and a strong, unique Encryption Key provided by your vendor:
      define('SCANTIX_LICENSING_SERVER_URL', 'https://your-licensing-server.com');
      define('SCANTIX_SHARED_SECRET', 'your_very_long_and_complex_shared_secret');
      define('SCANTIX_ENC_KEY', 'a_strong_unique_encryption_key_for_daughter');
    • Once these constants are defined in wp-config.php, the fields on the settings page will become read-only, and the Scantix plugin will use the values from your wp-config.php file.

Core Functionality Usage

  1. Enable QR for Products:
    • Edit any WooCommerce product you wish to sell as an event ticket.
    • In the “Product data” metabox, go to the “General” tab.
    • Check the “Enable QR Code / Ticket Features” checkbox for any product you want to sell as a QR ticket.
    • Update/Publish the product.
  2. Customer Purchase:
    • Customers buy tickets through your WooCommerce store as normal.
    • Each order item automatically generates a unique QR code when the order is marked as Processing or Completed.
  3. Delivering Tickets (Automatic Email Delivery):
    • The customer receives a confirmation email containing their unique QR code(s).
    • They can download, print, or store the code on their phone for easy entry.
    • Customizing Emails (Optional): You can modify the WooCommerce order email template to include event-specific instructions, logos, or links.
  4. Verifying Tickets at the Event (Scanner Workflow):
    • Scanner Authentication:
      • Each person scanning tickets needs a WordPress user account on your site.
      • This user account must be assigned a role with the scantix_verify_qr_tickets capability (e.g., the custom “Scantix Scanner” role, shop_manager, or administrator).
      • The scanner logs into your WordPress site via a web browser on their mobile device or dedicated scanning device.
    • Scanning QR Codes:
      • The scanner uses their device’s native camera app or a dedicated third-party QR scanner app to read the QR code on the attendee’s ticket.
      • Each QR code contains a unique URL pointing back to your site’s verification endpoint.
      • The device’s browser will automatically open this URL.
    • Live Validation:
      • The Scantix plugin intercepts the URL. Since the scanner is logged in and has the correct capability, the plugin performs real-time validation against your database.
      • The system instantly determines:
        • Valid & Unused → Entry Allowed
        • Invalid or Expired → Denied
        • Already Used → Denied
    • Automatic Status Update: Once scanned, a ticket is marked as Used and time-stamped in the admin panel. The customer’s PII (name, email) is encrypted when stored and decrypted only when needed for display during verification.
  5. Managing Tickets in the Dashboard:
    • Navigate to Scantix → QR Orders Dashboard in the admin menu.
    • Dashboard Features: A live, centralized table showing:
      • Ticket Tag (unique code)
      • Order ID
      • Customer Name & Email (decrypted for display)
      • Product Name
      • QR Code Thumbnail (clickable for lightbox preview)
      • Status (Not Used, Used, Re-Scanned / Denied)
      • Used Date
      • Re-Issue Count
      • Re-Issue Button
    • Color-coded Statuses for instant clarity: Grey – Not Used, Green – Used, Red – Denied / Re-Scanned.
  6. Re-Issuing Tickets:
    • Re-Issue from Dashboard: In the QR Orders Dashboard, click Re-Issue next to any ticket.
    • A confirmation popup ensures no accidental re-issues.
    • New QR Code Creation: A fresh QR code is generated and replaces the old one. The ticket’s “Used” status resets. A re-issue count increments for audit tracking.
    • Customer Notification: The customer automatically receives the new QR code via email.

Post-Event Management

  • Export your ticket data to CSV for recordkeeping or follow-ups.
  • Review scan history, re-issue counts, and usage stats for analytics.
  • Quickly identify invalid or duplicate entries for security reporting.

Security Highlights

  • Licensing Architecture: The Scantix plugin relies on a separate licensing server for license verification, ensuring secure and centralized license management.
  • UUID-based QR codes: Each ticket is unique and impossible to guess.
  • Mandatory Server-side Validation: Prevents offline tampering or duplication.
  • Robust Audit Trail: Logs all scans, re-issues, and ticket actions.
  • Granular Role-Based Access Control (RBAC): Custom capabilities (scantix_manage_qr_tickets, scantix_view_qr_dashboard, scantix_reissue_qr_tickets, scantix_verify_qr_tickets) ensure users only have access to what they need.
  • Secure Credential Management: Prioritizes defining sensitive secrets (Mother URL, Shared Secret, Encryption Keys) in wp-config.php to keep them out of the database.
  • PII Application Encryption: Customer names and emails are encrypted when stored as order item meta and decrypted only when needed for display or verification.
  • Authenticated Verification Endpoint: The QR verification REST API requires authenticated users with specific capabilities, preventing unauthorized access.
  • One-scan entry system: Prevents double use or re-entry.

Additional Tools

  • Search & Filter by customer, order, or ticket status.
  • CSV Export for reports or audits.
  • Lightbox Preview for quick QR inspection.