REST API

v1.1 · updated Apr 1, 2026

$100 Buy License Try Free Docs
Frontend changes: Minimal
Add a button and a few lines of CSS to your template 7-day trial · no license key needed

60 endpoints. One plugin.

KVS REST API plugin provides a complete JSON API for your site. Videos, albums, categories, models, channels, playlists, posts, tags, search, comments, ratings, favorites, watch later, subscriptions, friends, messages, user profiles and admin operations — all accessible through clean REST endpoints.

Two authentication modes: API key for server-to-server admin operations, and user tokens for mobile app / SPA frontend flows. Every endpoint respects KVS access control — private and premium content is protected the same way as on the website.

REST API admin panel

Video formats & access control

Video detail endpoints return available formats (preview, 720p, etc.) with signed URLs — the same hotlink-protected URLs that KVS player uses. Each format shows whether the current user can access it.

Access control follows KVS logic exactly: is_private + access_level_id + memberzone settings + premium status + token purchases. Public videos are accessible to guests. Premium content requires authentication.

Mobile app ready

Built for the use case that KVS community has been requesting for years — mobile applications. Login returns a Bearer token, all endpoints accept JSON, responses include pagination headers (Link, X-Total-Count).

CORS headers included for browser-based SPA frontends. Rate limiting per IP protects against abuse. Debug logging helps diagnose issues during development.

What's included

  • Plugin files (PHP + Smarty admin template + EN/RU language files)
  • 60 REST endpoints (GET, POST, PUT, DELETE)
  • Token-based auth (API key + user tokens)
  • Video format URLs with hotlink protection
  • Full access control matching KVS logic
  • Rate limiting per IP
  • CORS support
  • Pagination with Link headers
  • OpenAPI 3.0 spec (import into Postman in one click)
  • Step-by-step documentation
  • Free updates

REQUIREMENTS

  • KVS 6.2.0 or higher
  • nginx (for URL rewrite)

Endpoints overview

  • Auth: login, logout
  • Videos: list, detail, comments, related, rate, comment, favorite, watch later, view tracking
  • Albums: list, detail, images, favorite
  • Categories: list, detail
  • Models: list, detail
  • Content Sources: list, detail
  • Channels: list, detail
  • Playlists: list, detail, videos
  • Posts: list, detail
  • Tags: list with search
  • Members: list, profile
  • Search: full-text video search
  • Me: profile, edit, favorites, watch later, history, subscriptions, friends, messages
  • Billing: packages, transactions, premium status, token purchases
  • Admin: create user, premium, tokens, stats

Changelog

v1.1 — April 2026

Added license key system with 7-day free trial. ECDSA-signed keys tied to domain. Native KVS admin UI for license management.

v1.0 — March 2026

Initial release. 60 REST API endpoints, token-based auth, video formats with signed URLs, full KVS access control, billing, rate limiting, CORS, OpenAPI 3.0 spec.