REST API - Plugixa Video

This page is for developers. The plugin has one REST namespace, pvx/v1, used by its own admin app, its player and its public pages. You can read the public routes from anywhere, call the others from code on the same site, or add routes of your own.

Every route lives under:

https://example.com/wp-json/pvx/v1/

Who can call what

There are no API keys: a request from outside the site is anonymous and reaches the public routes only. Back-office routes check the plugin’s capabilities and WordPress’s ownership rules, so a creator reaches their own videos only (see Creators and moderation PRO). A route of an app that is switched off in the App manager does not answer.

Answers

Every answer has the same shape. A list carries the totals in meta:

{
  "success": true,
  "data": [ { "id": 838, "title": "Iceland: The Ring Road", "channel": "Far Places" } ],
  "meta": { "total": 100, "pages": 100 }
}

An error is a standard WordPress REST error with a code, a message and the HTTP status in data.status, for example plugixa_video_forbidden or plugixa_video_not_found.

Public routes

Lists take these query parameters:

GET /videos also takes access (free, members, paid), with Pro type (video, movie, episode), duration (short under 4 minutes, medium 4 to 20, long over 20), orderby (date, views, title), category, tag, channel, with Pro series, include[] (ids) and upcoming (also list scheduled videos).

Examples

The latest five videos of the Far Places channel (channel id 692 on the demo site):

curl "https://example.com/wp-json/pvx/v1/videos?channel=692&per_page=5"

The most viewed movies (Pro):

curl "https://example.com/wp-json/pvx/v1/videos?type=movie&orderby=views"

All categories:

curl "https://example.com/wp-json/pvx/v1/terms?taxonomy=pvx_category"

What to watch after video 838 (Pro):

curl "https://example.com/wp-json/pvx/v1/videos/838/related?limit=6"

A video’s source

GET /videos/{id}/source answers with the type, title, poster, duration, chapters, subtitles (with Pro) and a playable url. For uploaded and linked files the url is a signed link that expires after a few minutes, so do not store it. The answer carries Cache-Control: no-store, private.

When the caller may not watch the video, the answer is an error with a short teaser (id, title, poster, access) for the lock screen:

Signed-in viewer routes

With Pro, the player also sends POST /videos/{id}/stats for Analytics PRO. It is open to anyone who may watch the video, and is not meant for other callers.

Back-office routes

These are what the admin app calls. They need a signed-in user with the right capability.

With Pro PRO, more routes appear under the same namespace: /checkout and /me/purchases, /me/memberships for signed-in buyers, /me/notifications, the payment provider notices at /webhooks/stripe and /webhooks/paypal, the series, related videos, uploads, subtitles and analytics routes above, and back-office routes for orders, plans, earnings, import, custom fields, AI subtitles, audio tracks and audience insights.

Adding your own routes

The plugixa_video_register_rest_routes action fires when the plugin registers its routes. It passes the namespace and the plugin’s service container, so your routes sit beside the plugin’s:

add_action( 'plugixa_video_register_rest_routes', function ( string $namespace ) {
	register_rest_route( $namespace, '/my-site/most-watched', array(
		'methods'             => 'GET',
		'callback'            => 'my_site_most_watched',
		'permission_callback' => function () {
			return current_user_can( 'plugixa_video_view' );
		},
	) );
} );

The plugin’s capabilities are plugixa_video_view, plugixa_video_create, plugixa_video_edit, plugixa_video_delete and plugixa_video_manage_settings. For events you can react to without a route, see Hooks.