mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-10-01 12:02:06 +02:00

Files

T

Divarion-D 040143215a docs: Full Docsify documentation (EN + RU) and migration replacement

Full bilingual documentation for XC_VM has been added
with Docsify SPA and the outdated database migration has been replaced.

## Docsify

- docs/index.html — SPA entry point: en-us/ru-ru routing,
search, syntax highlighting (bash, PHP, SQL, nginx, JSON)

## EN Documentation

- docs/en/info/faq.md — FAQ (12 questions: streams, access, database, SSL, updates, permissions)
- docs/en/info/migration_guide.md — migration guide from other systems
- docs/en/info/update.md — step-by-step update via the web panel
- docs/en/info/watch_folder.md — Watch Folder: workflow, PTN/guessit parsers, configuration
- docs/en/updates_checklist.md — release preparation checklist

## RU Documentation (fully localized)

- docs/ru/README.md — Main Page
- docs/ru/_sidebar.md — Sidebar Navigation
- docs/ru/administration/ssl-generation.md — Self-Signed SSL Generation
- docs/ru/administration/update-system.md — Update Mechanism (PHP → Python → Post-Update)
- docs/ru/api/playlist.md — Playlist API with Error Codes
- docs/ru/api/system_api.md — System API (13 endpoints)
- docs/ru/api/xtreamcodes_api.md — XtreamCodes API (Authorization, Live, VOD, TV Series, EPG)
- docs/ru/builds/build_binaries.md — nginx build, nginx_rtmp, PHP-FPM, network
- docs/ru/builds/build_ffmpeg.md — Building FFmpeg 8.0 with NVENC/CUDA
- docs/ru/builds/build_system.md — MAIN vs. LB build system
- docs/ru/development/cli-tools.md — CLI: 26 commands, 25 crons, 8 daemons, database migrations
- docs/ru/info/faq.md — FAQ (12 questions)
- docs/ru/info/migration_guide.md — Migration guide
- docs/ru/info/update.md — Updating via the control panel
- docs/ru/info/watch_folder.md — Watch Folder
- docs/ru/updates_checklist.md — Release checklist

## Migrations

- Removed: 001_drop_watch_folders_plex_token.sql (Deprecated)
- Added: 001_update_crontab_filenames.sql — removes the .php suffix from filenames in the crontab table (switches to console.php commands)

2026-03-15 00:02:19 +03:00

6.0 KiB

Raw Blame History

📺 Получить список воспроизведения

Этот API предоставляет функции аутентификации и создания плейлистов для XC_VM. Клиенты могут аутентифицироваться с помощью имени пользователя/пароля или токена, после чего генерируется персонализированный плейлист.

📂 Расположение файла

Playlist API обрабатывается PlaylistApiController:

src/public/Controllers/Api/PlaylistApiController.php

🔑 Аутентификация

API требует аутентификацию либо через имя пользователя и пароль, либо через токен. Это обеспечивает безопасность доступа к контенту.

Базовый URL

http://<ваш-домен>:80/playlist

🚀 Конечные точки

1. Аутентификация и создание плейлиста

Метод и конечная точка:

GET /

Параметры запроса:

Параметр	Тип	Требуется	Описание
username	string	Yes*	Имя пользователя для аутентификации (обязательно, если не используется `token`).
password	string	Yes*	Пароль для аутентификации (требуется, если `token` не используется).
token	string	Yes*	Токен аутентификации (требуется, если имя пользователя и пароль не используются).
type	string	No	Тип устройства (по умолчанию: `m3u_plus`).
key	string	No	Тип контента (live — прямой эфир, movies — фильмы, radio_streams — радио, series — сериалы).
output	string	No	Формат вывода (hls или m3u).
nocache	boolean	No	Если true, отключается кэширование.

💡 Yes — обязательно один из вариантов: либо username/password, либо token.

Примеры запросов:

curl -X GET "http://<your-domain>:80/playlist/username/password/type&output=hls&key=live"

curl -X GET "http://<your-domain>:80/playlist/token/type&output=hls&key=live"

Ответ:

Файл плейлиста в указанном формате (M3U или HLS).

❌ Коды ошибок

В случае ошибок API возвращает соответствующие коды для диагностики проблем.

Код ошибки	Описание
NO_CREDENTIALS	Отсутствуют данные аутентификации.
INVALID_CREDENTIALS	Неверное имя пользователя, пароль или токен.
BLOCKED_USER_AGENT	Агент пользователя заблокирован.
EXPIRED	Срок действия учетной записи истек.
DEVICE_NOT_ALLOWED	Тип устройства не разрешен.
BANNED	Пользователь заблокирован.
DISABLED	Учетная запись отключена.
EMPTY_USER_AGENT	Агент пользователя необходим, но отсутствует.
NOT_IN_ALLOWED_IPS	IP-адрес не разрешен.
NOT_IN_ALLOWED_COUNTRY	Страна не разрешена.
NOT_IN_ALLOWED_UAS	Агент пользователя не разрешен.
ISP_BLOCKED	Провайдер заблокирован.
ASN_BLOCKED	Применено ограничение ASN.
DOWNLOAD_LIMIT_REACHED	Слишком много запросов.
GENERATE_PLAYLIST_FAILED	Не удалось сгенерировать список воспроизведения.

⚠️ Совет: Проверьте логи сервера для дополнительных деталей при возникновении ошибок.

🧾 Примечания

Параметры запроса: Убедитесь, что все параметры указаны корректно, чтобы избежать ошибок аутентификации.
Ограничения: API применяет фильтры по агенту пользователя, IP-адресу и стране для повышения безопасности.
Защита от перегрузки: Установлены лимиты на количество запросов, чтобы предотвратить чрезмерную нагрузку на сервер.
Рекомендации: Для тестирования используйте инструменты вроде cURL или Postman. В продакшене интегрируйте с вашим приложением для автоматизированной генерации плейлистов.

💬 Если возникнут вопросы по интеграции, создайте issue в репозитории.

6.0 KiB Raw Blame History