Magento 2 Integration
Securely sync and access your Magento 2 order and customer data with VESSOT's enterprise-grade encryption. Fully open source with automatic synchronisation.
What It Does
The VESSOT Secure Portable Data extension seamlessly integrates your Magento 2 store with VESSOT's encrypted storage service, providing secure, portable data synchronisation and access for your most critical business data.
Automatic Sync
Orders and customer data sync automatically on create or update
Client-Side Encryption
All data encrypted before leaving your servers with AES-256-GCM
Queue-Based Processing
Reliable sync with controlled batch processing every 15 minutes
Mass Actions
Bulk synchronisation support from admin grids
Prerequisites
VESSOT Account Required
This extension requires a VESSOT account. Create your account and refer to the sections below, and the user guide for full setup and usage instructions.
Installation
FULLY OPEN SOURCE: Review the code on GitHub. Licensed under OSL-3.0
Install via Composer from the root of your Magento installation:
composer require vessot/magento-secure-portable-data
Then run these commands to enable and configure the extension:
NOTE: The extension automatically installs the vessot/crypt library as a dependency, which handles client-side encryption and API communication.
Configuration
Step 1: Environment Variables
Security Best Practice
Your integration token and encryption key are stored as environment variables (not in the database) to prevent accidental exposure through backups or version control.
Set these two environment variables for your web server (see our API Setup Guide for detailed examples):
VESSOT_INT_TOKEN=your_integration_token
VESSOT_CRYPT_KEY=your_encryption_key
Step 2: Admin Configuration
Navigate to Stores → Configuration → VESSOT → Data Sync in your Magento admin panel and configure:
1. Storage Key Identity
Enter a unique, non-specific identifier for this Magento installation (e.g., "production", "store1"). This prevents storage key conflicts if you use the extension on multiple Magento instances.
Important: Set this before enabling data sync and don't change it later.
2. Sync Order Data
Set to Yes to enable automatic synchronisation of order data to VESSOT.
3. Sync Customer Data
Set to Yes to enable automatic synchronisation of customer data to VESSOT.
What Gets Synced
Order Data
- General order information
- Shipping address
- Billing address
- Payment information
- All order items
Customer Data
- General customer information
- All custom attributes
- All extension attributes
- Newsletter consent
- All addresses
- VESSOT storage keys for customer's orders
All data is encrypted client-side before transmission using AES-256-GCM encryption.
How It Works
Automatic Synchronisation
Once configured, data syncs automatically whenever:
Orders are:
- • Placed by customers
- • Created by admin users
- • Modified or updated
Customers:
- • Create accounts
- • Update profile information
- • Add or modify addresses
Queue Processing
Sync operations use Magento's message queue system for reliable processing:
- Automatic processing: Queues are processed via cron every 15 minutes
- Batch limits: 500 orders and 50 customers per batch
- Manual processing: Use CLI commands to immediately process entire queue
Manual Bulk Sync
For existing data or bulk operations, use the mass action "Queue for VESSOT Sync" from:
- Sales → Orders grid
- Customers → All Customers grid
CLI Queue Processing
Process queues manually via command line:
bin/magento queue:consumers:start vessot.order.process.save.execute
bin/magento queue:consumers:start vessot.customer.process.save.execute
Viewing Storage Keys
After data is synced, you can view the VESSOT storage keys in the Magento admin:
Order Keys
View order storage keys in the Information tab when viewing an order.
Customer Keys
View customer storage keys in the Customer View tab when viewing a customer account.
Database Access
Storage keys can also be queried directly from the database:
vessot_order_key
vessot_customer_key
Retrieving Data on Other Systems
Access your synced Magento data from any other system using the vessot/crypt library. This enables powerful cross-platform data sharing while maintaining security.
Use Cases
- • Build custom analytics dashboards
- • Integrate with ERP systems
- • Create multi-store data aggregation
- • Enable business intelligence tools
See the API Setup Guide for complete instructions on retrieving and working with your encrypted Magento data.
Need Help?
Our team is here to support your integration. Whether you need technical assistance, have questions about the extension, or want to discuss your specific use case, we're happy to help.