django-affiliate-system 0.1.0a5

A comprehensive Django affiliate marketing and referral tracking system

Django Affiliate System

A comprehensive, production-ready Django affiliate marketing and referral tracking system with built-in REST API support.

Features

• 🎯 Multi-tenant Support - Manage multiple affiliate programs
• 🔗 Referral Link Management - Generate and track custom referral links
• 📊 Advanced Analytics - Track clicks, conversions, and commissions
• 💰 Commission Calculation - Flexible commission rules and payouts
• 🔐 Hybrid Authentication - JWT and API key authentication
• 📱 Session Tracking - Multi-touch attribution models
• 🎨 RESTful API - Complete REST API with Django REST Framework
• 🔔 Webhook Support - External conversion tracking
• ⚡ Celery Task Support (Optional)

Requirements

• Python 3.9+
• Django 4.0+
• Django REST Framework 3.14+

Installation

Basic Installation

pip install django-affiliate-system

With Optional Dependencies

# With Celery support
pip install django-affiliate-system[celery]

# With all optional features
pip install django-affiliate-system[all]

Quick Start

1. Add to Installed Apps

Add django_affiliate_system and its dependencies to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'rest_framework',
    'rest_framework_simplejwt',
    'django_affiliate_system',
]

2. Add Middleware

MIDDLEWARE = [
    # ...
    'django_affiliate_system.middleware.CORSMiddleware',
    'django_affiliate_system.middleware.TenantMiddleware',
]

3. Configure Settings

# Django REST Framework
REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'django_affiliate_system.authentication.HybridAuthentication',
    ],
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',
    ],
}

# Django Affiliate System
AFFILIATE_SYSTEM = {
    'DOMAIN_PROTOCOL': 'https',
    'DOMAIN': 'yourdomain.com',
    'DEFAULT_COMMISSION_RATE': 10.0,  # 10%
    'COOKIE_DURATION_DAYS': 30,
    'ALLOWED_CORS_ORIGINS': [
        'http://localhost:3000',
        'https://yourdomain.com',
    ],
}

4. Include URLs

from django.urls import path, include

urlpatterns = [
    # ...
    path('affiliate/', include('django_affiliate_system.urls')),
]

5. Run Migrations

python manage.py migrate django_affiliate_system

6. Create a Tenant

from django_affiliate_system.models import Tenant
from django.contrib.auth import get_user_model

User = get_user_model()
owner = User.objects.create_user('[e-mail]', password='password')

tenant = Tenant.objects.create(
    name="My Affiliate Program",
    slug="my-program",
    destination_url="https://mysite.com",
    owner=owner,
    default_commission_rate=15.0
)

print(f"API Key: {tenant.api_key}")

API Usage

Authentication

The system supports two authentication methods:

1. JWT Authentication (for user-facing APIs)

# Get token
curl -X POST http://localhost:8000/affiliate/api/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "[e-mail]", "password": "password"}'

# Use token
curl http://localhost:8000/affiliate/api/affiliates/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

2. API Key Authentication (for tenant APIs)

curl http://localhost:8000/affiliate/api/tenants/ \
  -H "X-API-Key: YOUR_TENANT_API_KEY"

Create an Affiliate

curl -X POST http://localhost:8000/affiliate/api/affiliates/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-API-Key: YOUR_TENANT_API_KEY" \
  -H "Content-Type: application/json"

Create a Referral Link

curl -X POST http://localhost:8000/affiliate/api/referral-links/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-API-Key: YOUR_TENANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "my-custom-link",
    "destination_url": "https://mysite.com/product"
  }'

Track Events

# Track a click
curl -X POST http://localhost:8000/affiliate/api/track/ \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "click",
    "referral_code": "AFFILIATE_CODE",
    "session_id": "unique-session-id"
  }'

# Track a conversion
curl -X POST http://localhost:8000/affiliate/api/track/ \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "purchase",
    "referral_code": "AFFILIATE_CODE",
    "session_id": "unique-session-id",
    "conversion_value": 99.99,
    "is_conversion": true
  }'

Get Affiliate Statistics

curl http://localhost:8000/affiliate/api/affiliates/stats/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-API-Key: YOUR_TENANT_API_KEY"

Models Overview

• Tenant - Platforms using the affiliate system
• Affiliate - Users who refer others
• ReferralLink - Unique referral links for affiliates
• ReferralAction - Track all referral actions (clicks, signups, purchases)
• Commission - Commissions earned from referrals
• Payout - Payments to affiliates
• CommissionRule - Rules for calculating commissions
• ReferralSession - Track user sessions across touchpoints

Advanced Features

Multi-Touch Attribution

from django_affiliate_system.services.tracking import process_tracking_event

action = process_tracking_event(
    data={
        'event_type': 'purchase',
        'referral_code': 'REF123',
        'session_id': 'session-uuid',
        'conversion_value': 100.00,
        'is_conversion': True
    },
    meta=request.META,
    use_sessions=True,
    attribution_model='first_click'  # or 'last_click'
)

Custom Commission Rules

from django_affiliate_system.models import CommissionRule

rule = CommissionRule.objects.create(
    tenant=tenant,
    name="Premium Product Commission",
    action_type="purchase",
    is_percentage=True,
    value=20.0,  # 20%
    min_value=10.00,
    max_value=100.00,
    is_active=True
)

Celery Tasks (Optional)

# tasks.py in your project
from django_affiliate_system.tasks import process_payout

# Trigger payout processing
process_payout.delay(payout_id=123)

Testing

# Install dev dependencies
pip install django-affiliate-system[dev]

# Run tests
pytest

# With coverage
pytest --cov=django_affiliate_system

Documentation

Full documentation is available at https://django-affiliate-system.readthedocs.io/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

• 📧 Email: [e-mail]
• 🐛 Issues: GitHub Issues
• 📖 Documentation: Read the Docs

Changelog

See CHANGELOG.md for a list of changes.

Credits

Created and maintained by Ayodeji Akenroye.

django-affiliate-system