Build a PHP App with JoonWeb CLI

Detailed technical documentation and implementation guide for Build a PHP App with JoonWeb CLI.

Build a JoonWeb App in PHP using JoonWeb CLI #

Requirements #

Step 1: Scaffold PHP App (joonweb app init) #

Step 2: Install Official JoonWeb PHP SDK #

Step 3: Understand App Manifest (joonweb.app.json) #

Step 4: Run Dev Server & Install on Dev Site (joonweb app serve) #

Step 5: Fetch Products using PHP SDK (joonweb/joonweb-sdk) #

Create or open `api/products.php` and use the SDK to query merchant store products:

```php
<?php
require_once __DIR__ . '/../vendor/autoload.php';

use JoonWeb\Client;

// Get session details passed from authentication
$shopDomain  = $_GET['shop'] ?? '';
$accessToken = $_SESSION['access_token'] ?? '';

// Initialize SDK Client
$client = new Client([
    'shop_domain'  => $shopDomain,
    'access_token' => $accessToken,
    'version'      => '26.0'
]);

// Fetch Products
try {
    $response = $client->get('products');
    $products = $response['products'] ?? [];
} catch (Exception $e) {
    die('Error fetching products: ' . $e->getMessage());
}
?>

<div class="product-list">
    <h2>Store Products</h2>
    <ul>
        <?php foreach ($products as $product): ?>
            <li>
                <strong><?php echo htmlspecialchars($product['title']); ?></strong> -
                <?php echo htmlspecialchars($product['sale_price']); ?>
            </li>
        <?php endforeach; ?>
    </ul>
</div>
```

Step 6: Integrate Vanilla App Bridge CDN #

Include the vanilla App Bridge script in `views/dashboard.php` to interact with the parent Admin iframe:

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>My PHP JoonWeb App</title>
    
    <script src="https://apps.joonweb.com/app-bridge.js"></script>
</head>
<body>
    <h1>Welcome to My Embedded PHP App</h1>
    <button id="pickerBtn">Select Product</button>

// Trigger native ProductPicker modal
        document.getElementById('pickerBtn').addEventListener('click', async () => {
            const Components = window.joonwebApp.actions.Components.create(window.joonwebApp);
            const selected = await Components.show('ProductPicker', 'select', {});
            console.log('Selected Product:', selected);
        });
    </script>
</body>
</html>
```

Read full component details in our [App Bridge Guide](/apps/app-bridge/app-bridge-overview).

Step 7: Deploy Your PHP App (joonweb app deploy) #

Troubleshooting #

What's Next? #

Last modified: Aug 26, 2026