API Overview

Introduction

The RakuWP REST API allows the WordPress plugin to communicate with the panel server. It handles license validation, site activation and deactivation, and service queries. All API endpoints are under the /api/v1/ prefix.

Authentication

API requests are authenticated using a license key sent in the request body. No API tokens or OAuth flows are needed — the license key itself serves as the authentication credential.

Available Endpoints

License Validation

POST /api/v1/license/validate

Validates a license key and returns the plan details, status, and site limits. Used by the plugin during initial setup.

Site Activation

POST /api/v1/license/activate

Activates a license on a specific site URL. Records the site's WordPress version, PHP version, and plugin version. Returns an activation token.

Site Deactivation

POST /api/v1/license/deactivate

Deactivates a license from a specific site. Frees up one slot in the site limit.

License Check

POST /api/v1/license/check

Periodic health check from the plugin. Updates the last check timestamp and reports current site versions.

Site Verification

POST /api/v1/site/verify

Verifies that a site is properly activated and the license is valid. Used for periodic validation.

Services List

GET /api/v1/services

Returns the list of all available services with their names, descriptions, versions, and categories.

Response Format

All responses are JSON. Successful responses include a success: true field. Error responses include an error field with a human-readable message and an appropriate HTTP status code (400, 401, 403, 404, or 500).