🛒 PrestaShop Management System

Modern, fast, and user-friendly REST API and Python Desktop Application developed for PrestaShop e-commerce platform.

📋 Table of Contents

Features
Technologies
Installation
- PHP API Setup
- Python Application Setup
Usage
API Documentation
Python Application
Security
Troubleshooting
Contributing
License

✨ Features

🔌 PHP REST API

✅ RESTful Architecture: Standard HTTP methods (GET, POST, PUT, DELETE)
✅ Product Management: Full CRUD operations
✅ Order Management: View orders and update status
✅ Secure: API Key authentication, IP restriction
✅ CORS Support: Cross-origin resource sharing
✅ JSON Format: All responses in standard JSON format
✅ Pagination: Automatic pagination for large datasets
✅ Filtering: Flexible search and filtering options
✅ SQL Optimization: High performance with direct SQL queries
✅ Error Handling: Detailed and clear error messages

🖥️ Python Desktop Application

✅ Modern Interface: User-friendly GUI with Tkinter
✅ Product Management: Add, edit, delete, search products
✅ Order Management: View orders, update status
✅ Detailed View: View product and order details
✅ Context Menus: Right-click menus for quick access
✅ Async Operations: Non-blocking UI with threading
✅ Auto Connection Test: API status monitoring
✅ Multi-language: Supports internationalization

🛠️ Technologies

Backend (PHP API)

PHP 7.2+
PrestaShop 1.7.x / 8.x
MySQL / MariaDB
Apache / Nginx

Frontend (Python Desktop)

Python 3.8+
Tkinter (GUI)
Requests (HTTP Client)
python-dotenv (Configuration)

📥 Installation

Requirements

PrestaShop installed web server
PHP 7.2 or higher
Python 3.8 or higher
MySQL/MariaDB database

1️⃣ PHP API Setup

Step 1: Upload Files

Create a folder in your PrestaShop root directory:

/your-prestashop/
  ├── prestapi/           # API folder
  │   ├── api.php
  │   ├── config.php
  │   ├── .htaccess
  │   ├── test.php
  │   └── classes/
  │       ├── ApiHandler.php
  │       ├── Response.php
  │       ├── ProductManager.php
  │       └── OrderManager.php

Step 2: Configure config.php

Open config.php and configure your settings:

<?php
// PrestaShop root directory
define('PS_ROOT_DIR', dirname(__FILE__) . '/../');

// Generate a secure API key
define('API_KEY', 'your_secret_api_key_here');

// Allowed IP addresses (empty array = public access)
define('ALLOWED_IPS', []); 

// Database settings
define('DB_SERVER', 'localhost');
define('DB_USER', 'your_db_user');
define('DB_PASSWD', 'your_db_password');
define('DB_NAME', 'your_db_name');
define('DB_PREFIX', 'ps_');

// API Settings
define('API_DEBUG', true);  // Development: true, Production: false
define('API_CORS_ENABLED', true);

Step 3: Test API

Open the test page in your browser:

https://yourstore.com/prestapi/test.php

or test the API directly:

https://yourstore.com/prestapi/api.php?resource=products&api_key=your_api_key

✅ If you get a successful response, PHP API is ready!

2️⃣ Python Application Setup

Step 1: Install Python Packages

# Navigate to project directory
cd prestapi

# Install required packages
pip install -r requirements.txt

Step 2: Configure config.env

Edit the config.env file:

# PrestaShop API Configuration
API_URL=https://yourstore.com/prestapi/api.php
API_KEY=your_secret_api_key_here

⚠️ Important: API_KEY must match the API_KEY in PHP API (config.php)!

Step 3: Run Application

python app.py

✅ Application opens and API connection is automatically tested!

📚 Usage

Python Desktop Application

Product Operations

List Products:

Select "📦 Products" from left menu
All products displayed in table

Search Products:

Type product name in search box
Click "Search" button

Add New Product:

Click "➕ New Product" button
Fill the form:
- Product Name (required)
- Price (required)
- Reference, EAN13, Stock Quantity
- Short Description
- Status (Active/Inactive)
Click "Save" button

Edit Product:

Right-click on product → "✏️ Edit"
or select product and click edit button

View Product Details:

Double-click on product
or right-click → "👁️ View Details"

Delete Product:

Right-click → "🗑️ Delete" → Confirm

Order Operations

List Orders:

Select "📋 Orders" from left menu
Recent orders displayed in table

View Order Details:

Double-click on order
3 tabs open:
- General Info: Order summary
- Customer Info: Customer and address
- Products: Products in order

Update Order Status:

Right-click → "✏️ Update Status"
Select new status:
- Awaiting Payment (1)
- Payment Accepted (2)
- Processing (3)
- Shipped (4)
- Delivered (5)
- Canceled (6)
- Refunded (7)
Click "Update" button

🔌 API Documentation

Authentication

API key must be sent with all requests:

Method 1: Header (Recommended)

curl -H "X-API-Key: your_api_key" https://yourstore.com/prestapi/api.php?resource=products

Method 2: Query String

curl https://yourstore.com/prestapi/api.php?resource=products&api_key=your_api_key

Product Endpoints

List All Products

GET /api.php?resource=products

Parameters:

page - Page number (default: 1)
limit - Products per page (default: 50, max: 100)
active - Status filter (0 or 1)
category - Category ID
search - Search in product name

Example:

curl -H "X-API-Key: your_api_key" \
  "https://yourstore.com/prestapi/api.php?resource=products&page=1&limit=10&search=tshirt"

Response:

{
  "success": true,
  "message": "Products retrieved successfully",
  "data": {
    "items": [
      {
        "id_product": "1",
        "name": "Sample T-Shirt",
        "price": "29.99",
        "stock_quantity": "100",
        "active": "1",
        "price_formatted": "29.99 ₺"
      }
    ],
    "pagination": {
      "total": 150,
      "page": 1,
      "limit": 10,
      "pages": 15
    }
  }
}

Get Single Product

GET /api.php?resource=products&id=1

Create New Product

POST /api.php?resource=products
Content-Type: application/json

{
  "name": "New Product",
  "price": 49.99,
  "reference": "REF123",
  "quantity": 100,
  "active": 1
}

Update Product

PUT /api.php?resource=products&id=1
Content-Type: application/json

{
  "price": 59.99,
  "quantity": 150
}

Delete Product

DELETE /api.php?resource=products&id=1

Order Endpoints

List All Orders

GET /api.php?resource=orders

Parameters:

page - Page number
limit - Orders per page
customer - Customer ID
status - Order status
date_from - Start date (YYYY-MM-DD)
date_to - End date (YYYY-MM-DD)

Get Single Order

GET /api.php?resource=orders&id=1

Update Order Status

PUT /api.php?resource=orders&id=1
Content-Type: application/json

{
  "current_state": 3
}

Response Format

Success:

{
  "success": true,
  "message": "Operation successful",
  "data": { ... }
}

Error:

{
  "success": false,
  "message": "Error message",
  "errors": null
}

HTTP Status Codes

200 - OK
201 - Created
400 - Bad Request
401 - Unauthorized (Invalid API key)
403 - Forbidden (IP restriction)
404 - Not Found
500 - Internal Server Error

🔒 Security

API Key

Generate a strong API key:

// Generate random key with PHP
define('API_KEY', bin2hex(random_bytes(32)));

IP Restriction

Allow access only from specific IPs:

define('ALLOWED_IPS', [
    '192.168.1.100',  // Office
    '203.0.113.50'    // Server
]);

HTTPS

⚠️ Always use HTTPS in production!

Debug Mode

Disable debug mode in production:

define('API_DEBUG', false);

🐛 Troubleshooting

API Connection Error

Problem: "Cannot connect to API"

Solution:

Check URL in config.env
Verify API key is correct
Ensure server is accessible

Kernel Container Error

Problem: "Kernel Container is not available"

Solution: ✅ This issue is resolved! API no longer depends on PrestaShop Kernel.

SQL Syntax Error

Problem: SQL syntax error

Solution: Check database prefix (config.php → DB_PREFIX)

Tkinter Not Installed

Problem: ModuleNotFoundError: No module named 'tkinter'

Solution:

Ubuntu/Debian:

sudo apt-get install python3-tk

macOS: Reinstall Python (includes Tkinter)

Windows: Ensure "tcl/tk" option is checked during Python installation

Module Not Found

Problem: ModuleNotFoundError: No module named 'requests'

Solution:

pip install -r requirements.txt

📊 Project Structure

prestapi/
├── 📁 PHP API (Backend)
│   ├── api.php                 # Main endpoint
│   ├── config.php              # Configuration
│   ├── test.php                # Test interface
│   ├── .htaccess               # URL rewriting
│   └── classes/
│       ├── ApiHandler.php      # Request handler
│       ├── Response.php        # Response handler
│       ├── ProductManager.php  # Product operations
│       └── OrderManager.php    # Order operations
│
├── 🐍 Python Desktop (Frontend)
│   ├── app.py                  # Main application
│   ├── api_client.py           # API client
│   ├── config.env              # Configuration
│   └── requirements.txt        # Python dependencies
│
└── 📄 Documentation
    ├── README.md               # This file
    └── README_PYTHON.md        # Python app details

🎯 Features and Development

Current Features ✅

Planned Features 🚀

🤝 Contributing

We welcome contributions!

Fork the repository
Create feature branch (git checkout -b feature/amazing-feature)
Commit changes (git commit -m 'Add amazing feature')
Push to branch (git push origin feature/amazing-feature)
Open Pull Request

📝 License

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

👨‍💻 Developer

PrestaShop API & Desktop Manager

🙏 Acknowledgments

PrestaShop community
Python Tkinter developers
All contributors

📞 Contact

For questions or suggestions, please open an issue.

📸 Screenshots

Python Desktop Application

Main Screen

Modern and clean design
Colorful status indicators
Easy navigation

Product Management

Table view
Search functionality
Context menus
Quick editing

Order Management

Detailed order view
Customer information
Product list
Status updates

PHP API Test Interface

Automatic API tests
Visual result display
Error details

🚀 Quick Start

For Developers

# Clone repository
git clone https://github.com/yourusername/prestapi.git

# Install PHP API
cd prestapi
# Upload to PrestaShop server

# Install Python app
pip install -r requirements.txt
python app.py

For Users

Download latest release
Follow installation guide above
Configure config.php and config.env
Run python app.py

💡 Tips

Quick Search: Use product search for fast lookup
Context Menu: Right-click for quick operations
Double Click: View details quickly
Keyboard Shortcuts: Enter to save, Escape to cancel
Multi-select: Planned for future versions

📈 Performance

Fast API: Direct SQL queries for optimal performance
Efficient Pagination: Handle large datasets smoothly
Async Operations: Non-blocking UI operations
Optimized Queries: Minimized database calls

🔧 Configuration Options

PHP API

PS_ROOT_DIR - PrestaShop root directory
API_KEY - API authentication key
ALLOWED_IPS - IP whitelist
DB_PREFIX - Database table prefix
API_DEBUG - Debug mode
API_CORS_ENABLED - CORS support

Python Application

API_URL - API endpoint URL
API_KEY - Authentication key

🌐 Localization

Currently supports:

Turkish (tr)
English (en)

Want to add more languages? Contributions welcome!

📦 Dependencies

PHP

PrestaShop 1.7+
PHP 7.2+
MySQL/MariaDB

Python

Python 3.8+
requests
python-dotenv
tkinter (included with Python)

⚡ Advanced Usage

Bulk Operations (Planned)

# Future feature
api.bulk_update_products([
    {'id': 1, 'price': 29.99},
    {'id': 2, 'price': 39.99}
])

Webhooks (Planned)

// Future feature
$api->registerWebhook('order.created', 'https://yourapp.com/webhook');

🎓 Learning Resources

⭐ If you like this project, please give it a star!

Made with ❤️ for PrestaShop community

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
api		api
README.md		README.md
README_PYTHON.md		README_PYTHON.md
api_client.py		api_client.py
app.py		app.py
config.env		config.env
requirements.txt		requirements.txt

AlrunaTech/PrestaShop-API

Folders and files

Latest commit

History

Repository files navigation

🛒 PrestaShop Management System

📋 Table of Contents

✨ Features

🔌 PHP REST API

🖥️ Python Desktop Application

🛠️ Technologies

Backend (PHP API)

Frontend (Python Desktop)

📥 Installation

Requirements

1️⃣ PHP API Setup

Step 1: Upload Files

Step 2: Configure config.php

Step 3: Test API

2️⃣ Python Application Setup

Step 1: Install Python Packages

Step 2: Configure config.env

Step 3: Run Application

📚 Usage

Python Desktop Application

Product Operations

Order Operations

🔌 API Documentation

Authentication

Product Endpoints

List All Products

Get Single Product

Create New Product

Update Product

Delete Product

Order Endpoints

List All Orders

Get Single Order

Update Order Status

Response Format

HTTP Status Codes

🔒 Security

API Key

IP Restriction

HTTPS

Debug Mode

🐛 Troubleshooting

API Connection Error

Kernel Container Error

SQL Syntax Error

Tkinter Not Installed

Module Not Found

📊 Project Structure

🎯 Features and Development

Current Features ✅

Planned Features 🚀

🤝 Contributing

📝 License

👨‍💻 Developer

🙏 Acknowledgments

📞 Contact

📸 Screenshots

Python Desktop Application

Main Screen

Product Management

Order Management

PHP API Test Interface

🚀 Quick Start

For Developers

For Users

💡 Tips

📈 Performance

🔧 Configuration Options

PHP API

Python Application

🌐 Localization

📦 Dependencies

PHP

Python

⚡ Advanced Usage

Packages