README

Welcome to the Clopri App SDK guide. This SDK provides a set of powerful classes to handle networking, storage, caching, and core business entities (Products, Sales, People) securely and efficiently.

1. HTTP Networking

Function: clopriFetch

A secure wrapper for making external HTTP requests. It includes built-in Anti-SSRF protection and handles header formatting automatically.

Options Configuration

Example

// GET Request
$response = clopriFetch('https://api.example.com/products');
if ($response['ok']) {
    echo $response['body'];
}

// POST JSON Request
$response = clopriFetch('https://api.example.com/orders', [
    'method' => 'POST',
    'headers' => ['Content-Type' => 'application/json'],
    'body' => json_encode(['product_id' => 123, 'qty' => 2])
]);

2. Input Handling

Class: clopriRequest

Safely retrieves and sanitizes input from GET, POST, and JSON body.

Available Types: string, int, float, bool, email, url, array.

Example

// URL: /app?id=50&active=true

// Get parameters safely
$id = clopriRequest::get('id', 0, 'int');
$isActive = clopriRequest::get('active', false, 'bool');

// Get JSON body data
$productName = clopriRequest::json('name', 'Untitled Product');

3. Storage System (Sandbox)

Class: clopriStorage

Provides a secure storage isolated per packageId.

Example

// Save configuration
$config = ['theme' => 'dark', 'notifications' => true];
clopriStorage::save('settings.json', $config);

// Read configuration
$data = clopriStorage::read('settings.json');

4. Caching System

Class: clopriCache

Example

// Check cache first
$stats = clopriCache::get('daily_stats');

if (!$stats) {
    // Calculate stats...
    $stats = ['visits' => 100, 'sales' => 5];
    // Save to cache
    clopriCache::set('daily_stats', $stats);
}

5. Core Entities

5.1 Class: ProductData

Manages inventory items and services.

Public Properties

Public Methods

Example

// Create a new product
$prod = new ProductData();
$prod->name = "Wireless Mouse";
$prod->barcode = "WM-001";
$prod->price_in = 10.00;
$prod->min_price = 20.00;
$prod->max_price = 25.00;
$prod->category_id = 1;
$prod->add();

// Search for a product
$results = ProductData::searchProduct("Mouse");

5.2 Class: SellData

Manages the core lifecycle of sales transactions, including invoicing, payments, cancellations, and advanced financial reporting.

Key Properties

Before using the methods, it is important to understand the main properties of the object.

Public Methods

Examples

1. Analyzing Sales Data (AI / Reporting) Retrieve a rich dataset to analyze which items are selling best with specific clients.

// Get the last 100 detailed records
$dataset = (new SellData())->getSellIA(100);

foreach ($dataset as $row) {
    echo "Client: {$row->nombre_cliente} bought {$row->nombre_item} for ${$row->total_venta}<br>";
}

2. creating a New Sale How to instantiate and save a sale manually.

$sale = new SellData();
$sale->person_id = 5;      // Client ID
$sale->total = 1500.00;    // Total Amount
$sale->cash = 1500.00;     // Amount Paid
$sale->payment_method = 'Credit Card';
$sale->note = "Sale created via API";

// Save to DB
$sale->add();

3. Checking Accounts Receivable Check for unpaid sales or debts.

// Get debts for a specific client (ID: 5)
$debts = SellData::getReportReceivable(
    client_id: 5,
    statuPayment: 'Pendiente' // Filter by 'Pending' status
);

foreach ($debts as $debt) {
    echo "Invoice #{$debt->id} - Owed: {$debt->remaining_debt} <br>";
}

5.3 Class: PersonData

Handles Clients, Employees, and Providers.

Public Properties

Public Methods

Example

// Register a new client
$client = new PersonData();
$client->name = "John";
$client->lastname = "Doe";
$client->email = "john@example.com";
$client->no = "00100200304"; // ID Document
$client->client_type_id = 1;
$client->add_client();

Clopri App SDK

support@clopri.com