This comprehensive guide walks through the process of integrating your Affelios program with XML SFTP data sources. The integration enables automatic data synchronization and seamless affiliate tracking for your business with secure file transfer.
Prerequisites
Before starting the integration process, ensure you have the following:- Active Affelios subscription - Any plan (Flex, Pro, or Enterprise)
- SFTP Server Access - Valid SFTP server credentials and access
- XML Data Files - Registration and Transaction XML files available on your SFTP server
- Whitelisted IP Addresses - SFTP server must allow connections from Affelios IP addresses
- Admin Access - Full administrative privileges to your Affelios account
The integration process requires coordination with your SFTP server administrator to whitelist Affelios IP addresses. Contact us via Intercom or email support@affelios.com to obtain the required IP addresses before proceeding.
Integration Benefits
Key Features
The Affelios XML SFTP integration provides powerful features to streamline your affiliate program management and boost performance with secure data transfer.
Automated Data Import
Automated Data Import
Seamless Data Management:
- Daily automatic import of customer registrations and transactions
- Real-time commission calculations based on actual revenue
- Automated deduction handling for payment fees and taxes
- No manual data entry required
Secure Data Transfer
Secure Data Transfer
Enhanced Security:
- Encrypted SFTP connections for secure file transfer
- Secure authentication with username/password or SSH keys
- Protected data transmission over SSH protocol
- Compliance with security best practices
Flexible Data Mapping
Flexible Data Mapping
Comprehensive Revenue Tracking:
- Custom field mapping for your specific XML format
- Support for multiple product categories
- Individual product revenue and transaction tracking
- Detailed commission breakdowns by product type
Advanced Attribution
Advanced Attribution
Precise Customer Attribution:
- Configurable cookie tracking periods
- Automatic ClickKey generation for proper attribution
- Customer registration and transaction linking
- Anonymous transaction prevention
Step-by-Step Integration Guide
Step 1: Create a Brand in Affelios
1
Access Brand Creation
Navigate to your Affelios dashboard and go to the “Brands” section in the left-hand navigation menu.
2
Create New Brand
Click “Create Brand” and fill in the required information for your business website.
3
Configure Brand Settings
Set up your brand with the proper tracking parameters and commission settings.
If you already have a brand set up, you can skip to Step 2. If you need help creating a brand, follow our Brand Creation Guide.
Brand Configuration Example
For a brand called “YourBusiness.com”, use these settings:Brand Step 1 - Basic Information
| Field | Example | Description |
|---|---|---|
| Name | Your Business | Display name shown to affiliates and in reports |
| Industry | Your Industry | Used to categorize and filter brands |
| External ID | yourbusiness | Unique value used externally (best practice) |
| Landing Page URL | https://yourbusiness.com?clickkey=[ClickKey] | Your website with ClickKey parameter for tracking |
Brand Step 2 - Advanced Settings
| Field | Example | Description |
|---|---|---|
| Auto-Approve Commissions | Enabled | Recommended to avoid data delays |
| Allow Anonymous Transactions | Disabled | Important: Keep disabled for proper attribution |
| Deposit Fees | 3% | Payment fees deducted from Net Revenue |
| Tax Rate Deduction | 21% | Applicable taxes |
| Net Revenue Deduction | 15% | Platform and operational costs |
Step 2: Configure XML SFTP Integration Settings
1
Access Integration Settings
Navigate to the “Brands” page and click the three dots next to your brand, then select “Integration Settings”.
2
Select XML SFTP Integration
Choose “Xml Sftp” from the available integration methods.
3
Configure SFTP Connection
Enter the SFTP server details and credentials.
Step 3: Set Up SFTP Connection Settings
SFTP Connection Configuration
Configure the connection settings for your SFTP server:
| Field | Example | Description |
|---|---|---|
| SFTP Hostname | sftp.yourbusiness.com | Your SFTP server hostname |
| SFTP Port | 22 | Standard SFTP port (22) or custom port |
| Username | your_username | SFTP server username |
| Password | your_password | SFTP server password |
| Registration Filename Template | /data/registrations/[YEAR]-[MONTH]-[DAY].xml | Path to Registrations file with date tokens |
| Transactions Filename Template | /data/transactions/[YEAR]-[MONTH]-[DAY].xml | Path to Transactions file with date tokens |
The filename templates use automatic token replacement: [YEAR] (e.g., 2030), [MONTH] (e.g., 12), [DAY] (e.g., 31). Affelios will request the previous day’s data each morning.
Step 4: Configure Field Mapping
After establishing a valid connection, you’ll need to map the XML fields to Affelios fields.Customer Field Mapping
Registration Data Mapping
Map the available fields from the Registrations XML to Affelios fields:
| Affelios Field | Description | External Field Example |
|---|---|---|
| Registration Date | The date the customer registered | registration_date |
| External Customer ID | Your system’s ID for the customer | customer_id |
| Click Key | Unique value generated by Affelios | click_key |
| Customer Username | Customer username or email | username |
| Country Code | 2-letter country code of the customer | country |
Transaction Field Mapping
Transaction Data Mapping
Map the available fields from the Transactions XML to Affelios fields:
| Affelios Field | Description | External Field Example |
|---|---|---|
| External Customer Id | Your system’s ID for the customer | customer_id |
| Transaction Date | The Date of the transaction | transaction_date |
| Deposits | Sum total of Deposits | deposits |
| Gross Revenue | Sum total of Revenue | revenue |
| Wagering | Sum total of Wagering/Bets | wagering |
Step 5: Enable Daily Import
1
Configure Import Settings
Toggle the import setting to “Enabled” and set the import time to “03:00 AM”.
2
Save Integration
Click “Save Integration” to complete the setup process.
3
Verify Connection
Affelios will automatically test the connection and validate the field mappings.
Affelios will now automatically download data from your SFTP server each morning at 3 AM and import data into your affiliate program according to your integration settings.
Data Import Management
Automatic Import Features
Once enabled, data import happens automatically and keeps your affiliate program synchronized with your SFTP data.
Import Process
Daily Data Retrieval
Daily Data Retrieval
Automated Process:
- Affelios connects to your SFTP server each morning at 3 AM
- Downloads previous day’s registration and transaction XML files
- Data is processed and mapped according to your configuration
- Commissions are calculated automatically
Data Validation
Data Validation
Quality Assurance:
- Connection validation before each import
- Field mapping verification
- XML format validation
- Error logging and reporting
Import Monitoring
Import Monitoring
Track Performance:
- View import logs in Settings > Imports
- Retry failed import attempts
- Reimport historical data by date range
- Monitor import success rates
Managing Imports
1
Monitor Import Status
Check the import logs in your Affelios dashboard to ensure data is being imported successfully.
2
Review Data Quality
Verify that customer registrations and transactions are being processed correctly.
3
Handle Import Errors
Use the retry functionality for any failed imports or contact support if issues persist.
4
Historical Data
Reimport historical data if needed using the date range selector in the imports section.
Commission Management
Automated Commission Processing
The XML SFTP integration automatically processes commissions based on your configured settings and field mappings.
Commission Calculation
Revenue-Based Commissions
Revenue-Based Commissions
Revenue Tracking:
- Commissions calculated on Gross Revenue
- Automatic deduction handling for fees and taxes
- Real-time commission updates
- Flexible commission structures
Deduction Management
Deduction Management
Automated Deductions:
- Deposit fees (e.g., 3% payment processing fees)
- Tax rate deductions (e.g., 21% applicable taxes)
- Net revenue deductions (e.g., 15% operational costs)
- Transparent deduction reporting
Custom Commission Plans
Custom Commission Plans
Flexible Commission Structures:
- Different rates for different product categories
- Customizable commission structures per product
- Tiered commission plans based on performance
- Automatic commission approval (recommended)
Troubleshooting
Common Issues
Here are solutions to common problems you might encounter during the XML SFTP integration process.
Connection Issues
Connection Issues
Cannot Connect to SFTP Server:
- Verify that your SFTP server has whitelisted the required Affelios IP addresses
- Check that your SFTP hostname and port are correct
- Ensure your SFTP credentials are valid and active
- Contact your SFTP server administrator to verify access
Data Import Problems
Data Import Problems
Data Not Importing:
- Check that your filename templates are correct
- Verify that XML files are being generated in the expected location
- Ensure your XML files are in the correct format and well-formed
- Review import logs for specific error messages
Field Mapping Issues
Field Mapping Issues
Incorrect Data Mapping:
- Verify that XML field names match your mapping configuration
- Check that all required fields are properly mapped
- Ensure XML files contain the expected data structure
- Test with a small sample of data first
Commission Calculation Problems
Commission Calculation Problems
Commissions Not Calculating:
- Verify that your commission plans are properly configured
- Check that field mappings include revenue fields
- Ensure auto-approve commissions is enabled
- Review deduction settings and percentages
Getting Help
1
Check Import Logs
Review the import logs in Settings > Imports for specific error messages and details.
2
Contact SFTP Administrator
Reach out to your SFTP server administrator for access or server-related issues.
3
Contact Affelios Support
Contact Affelios support via Intercom or email for integration-specific problems.
4
Provide Details
Include information about error messages, import logs, and steps you’ve already tried.
Best Practices
Optimization Tips
Follow these best practices to ensure your XML SFTP integration runs smoothly and effectively.
Data Management
Data Management
Keep Your Data Clean:
- Regularly monitor import logs for any issues
- Ensure XML files are generated consistently and are well-formed
- Verify that all required fields are being populated
- Keep historical data for reporting and analysis
Security Best Practices
Security Best Practices
Maintain Security:
- Use strong passwords for SFTP access
- Regularly rotate SFTP credentials
- Monitor SFTP access logs
- Keep SFTP server software updated
Commission Planning
Commission Planning
Optimize Your Commission Structure:
- Set competitive commission rates for your industry
- Consider different rates for different product categories
- Monitor affiliate performance and adjust rates accordingly
- Provide clear commission information to affiliates
Integration Monitoring
Integration Monitoring
Stay on Top of Performance:
- Set up alerts for failed imports
- Regularly review commission calculations
- Monitor data quality and consistency
- Keep backup records of important transactions
Affiliate Support
Affiliate Support
Support Your Affiliates:
- Provide clear information about your products
- Share performance insights and marketing tips
- Respond promptly to affiliate questions
- Recognize top-performing affiliates
Next Steps
Your Integration is Complete!
Congratulations! Your XML SFTP integration is now successfully set up with Affelios. Your affiliates can begin marketing your products immediately.
What Happens Next
1
Data Synchronization
Affelios will automatically download and import customer registrations and transactions from your SFTP server each day.
2
Commission Processing
Commissions will be calculated and processed automatically based on your configured settings.
3
Affiliate Onboarding
Start inviting affiliates to join your program or promote it to attract new partners.
4
Performance Monitoring
Use the Affelios dashboard to monitor clicks, conversions, and commission payouts.
5
Program Optimization
Continuously optimize your program based on performance data and affiliate feedback.
Additional Resources
Further Reading
- Brand Creation Guide - Complete brand configuration
- Commission Plan Management - Advanced commission strategies
- Affiliate Onboarding - Guide for your new affiliates
- Reporting & Analytics - Understanding your program performance
- API Documentation - Advanced integration options
Need additional help? Our support team is available to assist with any questions or issues you might have with your XML SFTP integration. Contact us via Intercom or email support@affelios.com.