Download the PHP package tourze/youzan-api-user-bundle without Composer

Youzan API User Bundle

中文

A Symfony bundle for managing Youzan API user data, providing comprehensive entities and synchronization commands for Youzan platform user management, including followers, staff, and related information.

Table of Contents

• Features
• Requirements
• Installation
• Configuration
• Quick Start
• Console Commands
• Entities
• Usage Examples
• Advanced Usage
• Security
• Contributing
• License

Features

• User Management: Complete user entity with profile information including gender, birthday, location, and contact details
• Follower Synchronization: Batch synchronization of WeChat follower data from Youzan API with progress tracking
• Staff Management: Comprehensive staff entity with personal and contact information
• Level & Mobile Info: Dedicated entities for tracking user level and mobile information
• WeChat Integration: Full WeChat user information management with OpenID and profile data
• Console Commands: Built-in commands for automated data synchronization with flexible date range options
• Batch Processing: Efficient batch processing for large datasets with configurable batch sizes
• Memory Optimization: Automatic memory management for processing large numbers of records

Requirements

• PHP 8.1 or higher
• Symfony 6.4 or higher
• Doctrine ORM 3.0 or higher
• tourze/youzan-api-bundle for API integration

Installation

Configuration

This bundle relies on the tourze/youzan-api-bundle for API connectivity. Ensure you have configured:

1. Youzan API credentials in your environment
2. Doctrine ORM for entity persistence
3. Proper database connections

Quick Start

1. Register the Bundle

Add the bundle to your config/bundles.php:

2. Update Database Schema

Run the database migration to create the required tables:

3. Configure Youzan API

Make sure you have configured the Youzan API bundle properly with your credentials.

Console Commands

youzan:sync:followers

Synchronizes WeChat follower information from Youzan API with support for date range filtering and batch processing.

Options:

• --account (-a): Account ID (optional, defaults to all accounts)
• --start-date (-s): Start date in Y-m-d format (optional, defaults to "-7 days")
• --end-date (-e): End date in Y-m-d format (optional, defaults to "now")

The command features:

• Progress bar display for real-time tracking
• Automatic batch processing (100 records per batch)
• Memory-efficient processing with periodic entity manager clearing
• Error handling with detailed error messages per account

Entities

User

Main user entity representing Youzan platform users with comprehensive profile information:

• Basic Info: Youzan OpenID, nickname (encrypted/decrypted), gender (using GenderEnum), platform type
• Location: Country, province, city information
• Profile: Avatar URL
• Account Association: Links to related Youzan account
• Relations: Connected to Staff, WechatInfo, and MobileInfo entities
• Timestamps: Automatic created/updated timestamps via Doctrine traits

Follower

WeChat follower entity synchronized from Youzan API:

• Identification: Youzan user ID and WeChat OpenID mapping
• Profile: Nickname, avatar URL, gender
• Location Data: Country, province, city information
• Follow Status: Follow state and timestamp tracking
• Trading Statistics: Traded count, total trade amount, points
• Account Association: Links to specific Youzan account

Staff

Staff entity for managing employee information:

• Personal Information: Name, email
• Company Information: Corporate name, corporate ID, KDT ID (store ID)
• User Association: Links to main User entity
• Timestamps: Automatic created/updated timestamps via Doctrine traits

LevelInfo

User level information tracking:

• User Association: Links to main User entity
• Level Details: Current level, experience points
• Progression: Level name, benefits, thresholds

MobileInfo

Mobile information management:

• User Association: Links to main User entity
• Mobile Details: Phone number, carrier, verification status
• Security: Verification timestamps, binding status

WechatInfo

WeChat-specific user data:

• User Association: Links to main User entity
• WeChat Profile: Union ID, OpenID, nickname
• Subscription: Subscribe status, subscribe time
• Profile Data: Avatar, language preference

Usage Examples

Basic Entity Usage

Repository Usage

Advanced Usage

Custom Synchronization Strategies

You can extend the synchronization process by creating custom command handlers:

Entity Extensions

Extend entities to add application-specific fields:

Event Subscribers

Listen to synchronization events:

Security

Data Protection

This bundle handles sensitive user data and implements several security measures:

• Encrypted Storage: Sensitive fields like mobile numbers support both encrypted and decrypted storage options
• Input Validation: All entity properties use Symfony validation constraints to prevent malicious data injection
• Data Sanitization: User-generated content is properly validated before persistence

Best Practices

1. Environment Variables: Store API credentials in environment variables, never in code
2. Database Security: Use secure database connections with SSL/TLS encryption
3. Access Control: Implement proper access controls for console commands in production
4. Data Minimization: Only synchronize necessary user data fields
5. Audit Logging: Consider implementing audit logs for sensitive operations

Validation Rules

The bundle enforces strict validation rules:

Contributing

Please see CONTRIBUTING.md for details.

License

The MIT License (MIT). Please see License File for more information.