Files
MiraviaConnector/connector-miravia/README.md

126 lines
3.9 KiB
Markdown
Raw Normal View History

# Miravia Feed API Connector
Official WordPress/WooCommerce plugin for Miravia marketplace integration using the native Feed API.
## Overview
This plugin provides seamless integration between WooCommerce and Miravia marketplace, allowing merchants to:
- Upload products using Miravia's official Feed API
- Manage product synchronization with job queue monitoring
- Download and process orders from Miravia
- Handle multiple Miravia accounts and profiles
## Key Features
### ✅ Feed API Integration
- **Official API**: Uses Miravia's native Feed API (no third-party proxies)
- **Asynchronous Processing**: Jobs are processed in background with real-time status monitoring
- **Bulk Operations**: Submit multiple products simultaneously
- **Error Handling**: Comprehensive error tracking and retry functionality
### ✅ Product Management
- **Direct Upload**: Submit individual products or bulk selections
- **Status Monitoring**: Real-time job status tracking in admin interface
- **Auto-sync**: Automatic product updates when WooCommerce data changes
- **Image Support**: Proper image handling for Miravia's requirements
### ✅ Order Management
- **Order Import**: Download orders from Miravia to WooCommerce
- **Status Sync**: Bidirectional order status synchronization
- **Shipping Labels**: Generate and manage shipping labels
- **Multi-account**: Support for multiple Miravia seller accounts
## Requirements
- **WordPress**: 5.0 or higher
- **WooCommerce**: 3.0 or higher
- **PHP**: 7.4 or higher
- **Miravia Account**: Active seller account with API credentials
## Installation
1. Upload the plugin files to `/wp-content/plugins/miravia-feed-connector/`
2. Activate the plugin through WordPress admin
3. Go to **Miravia > Configuration** and enter your API credentials
4. Enable "Use Feed API Only" option
5. Test your API connection
## Configuration
### API Credentials
Navigate to **Miravia > Configuration** and provide:
- **App Key**: Your Miravia/AliExpress App Key
- **Secret Key**: Your Miravia/AliExpress Secret Key
- **Access Token**: Your personal seller access token
### Feed API Settings
Enable "Use Feed API Only" to use the official Miravia Feed API (recommended for all seller accounts).
## Usage
### Product Upload
1. Go to **Miravia > Products**
2. Select products using checkboxes
3. Click "Submit Selected to Feed API"
4. Monitor progress in **Miravia > Jobs**
### Job Monitoring
The Jobs Queue provides:
- Real-time status updates
- Filtering by status (Pending, Processing, Completed, Failed)
- Error details and retry functionality
- Processing time tracking
### Order Management
Orders are automatically downloaded from Miravia and created as WooCommerce orders with proper status mapping.
## Development
### Architecture
- **Feed Manager**: Core job handling (`MiraviaFeedManager`)
- **SDK Integration**: Direct API client (`MiraviaSdk`, `SimpleIopClient`)
- **Database**: Custom tables for jobs and sync data
- **AJAX Interface**: WordPress-native AJAX endpoints
### Database Tables
- `wp_miravia_feed_jobs`: Feed API job tracking
- `wp_miravia_accounts`: Seller account credentials
- `wp_miravia_profiles`: Product upload profiles
- `wp_miravia_products`: Product sync status
## Support
For issues, feature requests, or development questions:
- **Repository**: https://github.com/CloudHost/miravia-woocommerce-connector
- **Issues**: https://github.com/CloudHost/miravia-woocommerce-connector/issues
- **Developer**: CloudHost Solutions
## Changelog
### Version 2.0.0
- Complete rebuild using official Feed API
- Removed WeComm proxy dependencies
- Added job queue system with real-time monitoring
- Enhanced error handling and retry functionality
- Updated branding to CloudHost Solutions
- Improved WordPress admin integration
### Version 1.x
- Legacy WeComm proxy integration (deprecated)
## License
GPL v3 or later. See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.html) for details.
---
**CloudHost Solutions** | https://cloudhost.es