manifest / ecommerce / affiliate-order-integration

Affiliate Order Integration

WordPress plugin with Composer support

by Sointech · github.com/nghiadinh115/affiliate-order-integration · website

★ 0stars

0forks

Install

No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:

wp plugin install https://github.com/nghiadinh115/affiliate-order-integration/archive/refs/heads/main.zip

Readme github.com/nghiadinh115/affiliate-order-integration ↗

Plugin WordPress tích hợp gửi đơn hàng đến website affiliate. Hỗ trợ đồng bộ đơn hàng WooCommerce với Sellmate affiliate network.

Mô tả

Affiliate Order Integration là plugin WordPress chuyên dụng để tự động gửi đơn hàng từ WooCommerce đến hệ thống affiliate Sellmate. Plugin này cung cấp:

Tích hợp API Sellmate (https://aff-api.sellmate.vn)
Xử lý CTV token và tracking
Tự động gửi đơn hàng khi thanh toán thành công
Quản lý logs và resend đơn hàng
Giao diện admin để cấu hình và monitor
Hỗ trợ cài đặt qua Composer

Yêu cầu hệ thống

PHP 7.4 hoặc cao hơn
WordPress 5.0 hoặc cao hơn
WooCommerce 5.0 hoặc cao hơn
Composer (cho việc cài đặt qua Composer)

Cài đặt

Phương pháp 1: Cài đặt thông qua Composer (Khuyến nghị)

Điều kiện tiên quyết:

Website WordPress đã có WooCommerce
Website đã có Composer setup
Plugin đã được push lên GitHub repository

Các bước chi tiết:

Bước 1: Backup composer.json

cd /path/to/wordpress-site
cp composer.json composer.json.backup

Bước 2: Thêm repository plugin

Từ GitHub (Production):

composer config repositories.affiliate-order-integration vcs https://github.com/NghiaDinh115/affiliate-order-integration.git

Từ Local (Development):

composer config repositories.affiliate-order-integration path /path/to/local/plugin

Bước 3: Cài đặt plugin

Từ GitHub:

composer require sointech/affiliate-order-integration:dev-main

Từ Local:

composer require sointech/affiliate-order-integration:@dev

Bước 4: Kiểm tra cài đặt

ls -la wordpress/wp-content/plugins/affiliate-order-integration

Bước 5: Kích hoạt plugin

Vào WordPress Admin → Plugins
Tìm "Affiliate Order Integration"
Click "Activate"

Phương pháp 2: Cài đặt thủ công

Tải xuống plugin từ GitHub
Giải nén vào thư mục wp-content/plugins/
Kích hoạt plugin trong WordPress Admin

Phương pháp 3: Template composer.json cho WordPress site mới

Nếu website chưa có Composer, tạo file composer.json:

{
    "name": "your-company/wordpress-site",
    "type": "project",
    "repositories": [
        {
            "type": "composer",
            "url": "https://wpackagist.org"
        },
        {
            "type": "vcs",
            "url": "https://github.com/NghiaDinh115/affiliate-order-integration.git"
        }
    ],
    "require": {
        "composer/installers": "^1.12",
        "johnpbloch/wordpress": "^6.8",
        "wpackagist-plugin/woocommerce": "^8.0",
        "sointech/affiliate-order-integration": "dev-main"
    },
    "extra": {
        "wordpress-install-dir": "wordpress",
        "installer-paths": {
            "wordpress/wp-content/plugins/{$name}/": [
                "type:wordpress-plugin"
            ],
            "wordpress/wp-content/themes/{$name}/": [
                "type:wordpress-theme"
            ]
        }
    },
    "config": {
        "allow-plugins": {
            "johnpbloch/wordpress-core-installer": true,
            "composer/installers": true
        }
    }
}

Quản lý Plugin

Cập nhật Plugin:

# Cập nhật lên version mới
composer update sointech/affiliate-order-integration --no-cache --prefer-source

# Hoặc cập nhật tất cả packages
composer update

Gỡ bỏ Plugin:

# Deactivate trong WordPress Admin trước
composer remove sointech/affiliate-order-integration

⚠️ Lưu ý quan trọng

WooCommerce Required: Plugin cần WooCommerce đã được cài đặt và kích hoạt
Sellmate API: Cần có Partner ID và cấu hình API endpoint
Backup: Luôn backup website trước khi cài đặt plugin mới
Test: Test trên staging environment trước khi deploy production
Version: Hiện tại sử dụng dev-main, sẽ có version stable sau
Permissions: Đảm bảo server có quyền ghi file và tạo database table
SSL: Khuyến nghị sử dụng HTTPS cho API calls bảo mật

🎯 Hướng dẫn cài đặt chi tiết

Cách 1: Cài đặt trên website WordPress có sẵn

# 1. Di chuyển đến thư mục WordPress root
cd /path/to/your-wordpress-site

# 2. Backup composer.json (nếu có)
cp composer.json composer.json.backup

# 3. Thêm repository plugin
composer config repositories.affiliate-order-integration vcs https://github.com/NghiaDinh115/affiliate-order-integration.git

# 4. Cài đặt composer/installers (nếu chưa có)
composer require "composer/installers:^1.0"

# 5. Cài đặt plugin
composer require sointech/affiliate-order-integration:dev-main

# 6. Xác minh plugin đã được cài
ls -la wp-content/plugins/affiliate-order-integration/

# 7. Vào WordPress Admin kích hoạt
# Admin → Plugins → "Affiliate Order Integration" → Activate

Cách 2: Cài đặt cho website WordPress mới

# 1. Tạo composer.json cho WordPress site
composer init --name="your-company/wordpress-site" --no-interaction

# 2. Thêm WordPress repositories
composer config repositories.wordpress composer https://wpackagist.org
composer config repositories.affiliate-order-integration vcs https://github.com/NghiaDinh115/affiliate-order-integration.git

# 3. Cài đặt WordPress core và dependencies
composer require johnpbloch/wordpress:^6.8
composer require composer/installers:^1.0
composer require wpackagist-plugin/woocommerce:^8.0

# 4. Cài đặt plugin
composer require sointech/affiliate-order-integration:dev-main

# 5. Cấu hình installer paths trong composer.json
# (Xem mẫu composer.json bên dưới)

# 6. Setup WordPress và kích hoạt WooCommerce
# 7. Kích hoạt Affiliate Order Integration

Cách 3: Download và cài thủ công

# Option A: Clone repository
git clone https://github.com/NghiaDinh115/affiliate-order-integration.git

# Option B: Download ZIP từ GitHub  
wget https://github.com/NghiaDinh115/affiliate-order-integration/archive/refs/heads/main.zip
unzip main.zip

# Copy vào wp-content/plugins/
cp -r affiliate-order-integration /path/to/wordpress/wp-content/plugins/

# Set permissions  
chmod -R 755 /path/to/wordpress/wp-content/plugins/affiliate-order-integration

Development Setup

# 1. Clone plugin repository
git clone https://github.com/NghiaDinh115/affiliate-order-integration.git /path/to/local/plugin

# 2. Trong WordPress site, link local plugin
cd /path/to/wordpress-site
composer config repositories.affiliate-order-integration path /path/to/local/plugin

# 3. Cài đặt development version
composer require sointech/affiliate-order-integration:@dev

# 4. Plugin sẽ được symlink - thay đổi local sẽ reflect ngay

🔧 Template composer.json hoàn chỉnh

Để cài đặt plugin trên website WordPress mới, sử dụng template này:

{
    "name": "your-company/wordpress-site",
    "type": "project",
    "repositories": [
        {
            "type": "composer", 
            "url": "https://wpackagist.org"
        },
        {
            "type": "vcs",
            "url": "https://github.com/NghiaDinh115/affiliate-order-integration.git"
        }
    ],
    "require": {
        "composer/installers": "^1.12",
        "johnpbloch/wordpress": "^6.8",
        "wpackagist-plugin/woocommerce": "^8.0",
        "sointech/affiliate-order-integration": "dev-main"
    },
    "extra": {
        "wordpress-install-dir": "wordpress",
        "installer-paths": {
            "wordpress/wp-content/plugins/{$name}/": [
                "type:wordpress-plugin"
            ],
            "wordpress/wp-content/themes/{$name}/": [
                "type:wordpress-theme"
            ]
        }
    },
    "config": {
        "allow-plugins": {
            "johnpbloch/wordpress-core-installer": true,
            "composer/installers": true
        }
    }
}

💻 Ví dụ cài đặt cho các môi trường

XAMPP/WAMP (Local Development)

# 1. Vào thư mục XAMPP htdocs
cd /Applications/XAMPP/xamppfiles/htdocs/your-wordpress-site
# Windows: cd C:\xampp\htdocs\your-wordpress-site

# 2. Cài đặt plugin qua Composer
composer config repositories.affiliate-order-integration vcs https://github.com/NghiaDinh115/affiliate-order-integration.git
composer require "composer/installers:^1.0"
composer require sointech/affiliate-order-integration:dev-main

# 3. Hoặc download thủ công
wget https://github.com/NghiaDinh115/affiliate-order-integration/archive/refs/heads/main.zip
unzip main.zip
mv affiliate-order-integration-main wp-content/plugins/affiliate-order-integration

# 4. Truy cập http://localhost/your-wordpress-site/wp-admin
# 5. Plugins → Activate "Affiliate Order Integration"

VPS/Dedicated Server (Production)

# 1. SSH vào server
ssh user@your-server.com

# 2. Backup trước khi cài
cd /var/www/html  # hoặc /home/user/public_html
tar -czf backup-$(date +%Y%m%d).tar.gz wp-content/

# 3. Cài qua Composer (khuyến nghị)
composer config repositories.affiliate-order-integration vcs https://github.com/NghiaDinh115/affiliate-order-integration.git
composer require sointech/affiliate-order-integration:dev-main

# 4. Hoặc download manual
wget https://github.com/NghiaDinh115/affiliate-order-integration/archive/refs/heads/main.zip
unzip main.zip
mv affiliate-order-integration-main wp-content/plugins/affiliate-order-integration

# 5. Set correct permissions
chown -R www-data:www-data wp-content/plugins/affiliate-order-integration
chmod -R 755 wp-content/plugins/affiliate-order-integration

# 6. Kích hoạt qua WordPress Admin

Shared Hosting (cPanel/FTP)

# 1. Download plugin về máy local
curl -L -o affiliate-order-integration.zip https://github.com/NghiaDinh115/affiliate-order-integration/archive/refs/heads/main.zip

# 2. Giải nén
unzip affiliate-order-integration.zip

# 3. Upload qua FTP/cPanel File Manager
# - Vào public_html/wp-content/plugins/
# - Upload thư mục affiliate-order-integration-main
# - Rename thành affiliate-order-integration

# 4. Kích hoạt trong WordPress Admin

Docker WordPress

Thêm vào docker-compose.yml:

version: '3.8'
services:
  wordpress:
    image: wordpress:latest
    volumes:
      - ./wp-content:/var/www/html/wp-content
      - ./composer.json:/var/www/html/composer.json
    environment:
      WORDPRESS_DB_HOST: db
      WORDPRESS_DB_USER: wordpress
      WORDPRESS_DB_PASSWORD: wordpress
      WORDPRESS_DB_NAME: wordpress

Sau đó:

# 1. Vào container
docker exec -it wordpress_container_name bash

# 2. Cài Composer (nếu chưa có)
curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

# 3. Cài plugin
composer config repositories.affiliate-order-integration vcs https://github.com/NghiaDinh115/affiliate-order-integration.git
composer require sointech/affiliate-order-integration:dev-main

Cấu hình

Sau khi cài đặt và kích hoạt plugin:

Vào WordPress Admin > Affiliate Integration
Cấu hình thông tin API:
- Partner ID: ID đối tác từ Sellmate
- API Endpoint: https://aff-api.sellmate.vn/api/v1/partnerSystem/orderCreate
- Enable Debug: Bật để ghi chi tiết logs
Test Connection để kiểm tra kết nối API
Lưu thay đổi

Cấu hình CTV Token

Plugin tự động xử lý CTV token thông qua:

URL parameter: ?ctv=TOKEN
Cookie tracking trong 30 ngày
Gửi kèm trong mỗi đơn hàng

Tính năng

✅ Tự động gửi đơn hàng: Khi WooCommerce order hoàn thành
✅ CTV Token Management: Tracking và cookie management
✅ Logs Management: Xem và quản lý logs gửi đơn
✅ Resend Orders: Gửi lại đơn hàng thất bại
✅ Test Connection: Kiểm tra kết nối API
✅ Debug Mode: Ghi chi tiết logs để debug
✅ Database Integration: Lưu trữ logs trong database
✅ Admin Interface: Giao diện quản lý thân thiện

Phát triển

Thiết lập môi trường phát triển

# Clone repository
git clone https://github.com/NghiaDinh115/affiliate-order-integration.git

# Cài đặt dependencies
composer install

# Chạy tests
composer run test

# Kiểm tra coding standards
composer run cs

# Fix coding standards
composer run cbf

# Build production version
composer run build

Cấu trúc thư mục

affiliate-order-integration/
├── admin/                    # Admin-specific files
│   ├── css/
│   ├── js/
│   └── views/
├── includes/                 # Core plugin classes
│   ├── class-admin.php      # Admin interface
│   ├── class-affiliate-api.php  # Sellmate API integration
│   └── class-order-handler.php # WooCommerce hooks
├── languages/               # Translation files
├── public/                  # Frontend assets
│   └── css/
├── tests/                   # Unit tests
├── composer.json           # Composer configuration
├── affiliate-order-integration.php # Main plugin file
└── README.md

API Documentation

Database Schema

Plugin tạo table wp_aoi_order_logs với cấu trúc:

CREATE TABLE wp_aoi_order_logs (
    id int(11) NOT NULL AUTO_INCREMENT,
    order_id bigint(20) NOT NULL,
    ctv_token varchar(255) DEFAULT NULL,
    api_response longtext,
    status varchar(20) DEFAULT 'pending',
    created_at datetime DEFAULT CURRENT_TIMESTAMP,
    updated_at datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (id),
    KEY order_id (order_id),
    KEY status (status)
);

WooCommerce Hooks

Plugin hook vào các events sau:

woocommerce_thankyou - Gửi đơn hàng sau khi thanh toán
woocommerce_order_status_completed - Đơn hàng hoàn thành
woocommerce_order_status_processing - Đơn hàng đang xử lý

Sellmate API Integration

Endpoint: https://aff-api.sellmate.vn/api/v1/partnerSystem/orderCreate

Request Format:

{
    "partnerId": 123,
    "orderCode": "WOO-12345",
    "orderValue": 1000000,
    "ctvToken": "ctv_token_here",
    "customerInfo": {
        "name": "Nguyen Van A",
        "phone": "0987654321",
        "email": "customer@example.com"
    },
    "products": [
        {
            "name": "Product Name",
            "price": 500000,
            "quantity": 2
        }
    ]
}

Troubleshooting

Plugin không gửi đơn hàng

Kiểm tra WooCommerce đã được kích hoạt
Xem logs trong Affiliate Integration > Logs
Bật Debug Mode để xem chi tiết
Test Connection với API

CTV Token không hoạt động

Kiểm tra URL có parameter ?ctv=TOKEN
Xem cookie aoi_ctv_token trong browser
Kiểm tra logs có ghi nhận token

API Connection Error

Kiểm tra Partner ID đúng định dạng
Xác minh API endpoint URL
Kiểm tra server có thể kết nối internet
Xem response trong logs để debug

Đóng góp

Fork repository trên GitHub
Tạo feature branch (git checkout -b feature/amazing-feature)
Commit changes (git commit -m 'Add some amazing feature')
Push to branch (git push origin feature/amazing-feature)
Tạo Pull Request

Changelog

1.0.0

Phiên bản đầu tiên
Tích hợp Sellmate API
CTV token management
WooCommerce integration
Admin interface
Database logging
Composer support

License

GPL v2 or later. Xem LICENSE để biết thêm chi tiết.

Support

GitHub Issues
Documentation
Email: contact@sointech.com
Website: https://sointech.sointech.dev

Roadmap

[ ] Hỗ trợ multiple affiliate networks
[ ] Dashboard analytics và báo cáo
[ ] Bulk resend orders
[ ] Webhook support từ Sellmate
[ ] Export/Import cấu hình
[ ] Multi-site support