The Panelr API allows you to integrate your Panelr installation with third-party applications. It is most commonly used with the e-commerce plugins to automate activation and renewal provisioning directly from your storefront.

Base URL

All requests are made to a single entry point:

  https://YOUR_DOMAIN/api/api.php

Replace YOUR_DOMAIN with the domain of your Panelr installation.

Request Format

The action to perform is passed as a query string parameter:

  https://YOUR_DOMAIN/api/api.php?action=get_products

GET actions = No request body required.

POST actions = Require a JSON body and Content-Type: application/json.

Response Envelope

Every response — success or failure — follows the same structure:

 {
    "success": true | false,
    "data":    { ... } | null,
    "error":   null | "Human-readable message"
  }

On success, "data" contains the result and "error" is null. On failure, "success" is false, "data" is null, and "error" describes the problem.

Example Success:

  {
    "success": true,
    "data": { "work_order_id": 42, "status": "queued" },
    "error": null
  }

Example Failure:

  {
    "success": false,
    "data": null,
    "error": "Product not found or inactive."
  }