REST API

The REST API provides programmatic access to all Vvveb data entities via standard HTTP methods.

Enabling

The API is enabled by default (defined('REST') || define('REST', true) in env.php) and accessible at /rest/. To disable it, define REST as false before the default applies.

For setup details, CORS and headless usage see REST API Setup.

Authentication

The auth mode is selected by config/rest.php (auth.mode): token (default) or http. In token mode send a Bearer token - an Authorization: Bearer <token> / Bearer header or a _token query parameter - validated with Admin::auth($token) using any admin user's API token. In http mode use HTTP Basic Auth (PHP_AUTH_USER/PHP_AUTH_PW) validated with Admin::login(). An authenticated admin session (cookie) also works. Permissions come from the admin's rest role rules (resource + action).

# HTTP Basic Auth
curl --user demo:demo 'https://demo.vvveb.com/rest/posts/hello-world-1'

# Bearer token
curl -H 'Authorization: Bearer mytoken' 'https://demo.vvveb.com/rest/posts/hello-world-1'

Admin endpoints require an authenticated admin with the appropriate role permissions. Front-end endpoints (products, posts) are publicly readable.

Endpoints

All endpoints follow the pattern: /rest/{resource} or /rest/{resource}/{id}. The full list of resources is defined in config/rest-routes.php; most database entities are exposed automatically.

Content

Products

Users & Orders

Cart

System

Example Requests

# List products
curl -b cookies.txt http://localhost/rest/products

# Get single product
curl -b cookies.txt http://localhost/rest/products/42

# Add to cart
curl -b cookies.txt -X POST http://localhost/rest/cart/42

# List posts with pagination
curl -b cookies.txt "http://localhost/rest/posts?start=0&limit=10"

Response Format

All responses are JSON:

{
    "product": [
        {
            "product_id": 1,
            "name": "Product Name",
            "price": "29.99",
            "image": "/media/product-image.jpg",
            "url": "/product/product-name"
        }
    ],
    "total": 100
}

Configuration

REST-specific configuration in config/rest.php (plain-array config):

return [
    'auth'    => ['mode' => 'token'], // or 'http' for HTTP Basic Auth
    'session' => ['driver' => 'request'],
    'email'   => ['driver' => 'mail'],
    'cache'   => ['driver' => 'file', 'servers' => [], /* ... */],
    // ...
];

Routes are defined in config/rest-routes.php (/rest/{resource} patterns mapping to default / default/crud/index / cart/cart modules with per-route methods and schema).

Extending

Plugins can add custom REST endpoints by:

1. Creating controllers in plugins/{plugin}/app/controller/ (front-end) or plugins/{plugin}/admin/controller/ (admin)
2. Adding routes via Routes::addRoute() in the plugin's app() method or via the Routes::init event
3. Registering new resources