mirror of https://github.com/Vateron-Media/XC_VM.git synced 2026-10-07 04:02:42 +02:00

Files

T

Divarion-D 76844fef11 docs: restructure, fix PSR-4 drift, and unify en/ru

Overhaul the Docsify documentation (English + Russian) so it matches the current
codebase and follows one consistent pattern.

Content accuracy (post-migration):
- Rewrite development/autoloader.md to PSR-4 / Composer (the old XC_Autoloader
  scanner, igbinary tmp/cache/autoload_map and registerDirectories are gone).
- PascalCase every source path (src/core -> src/Core, domain/Stream, cli/Commands,
  public/Controllers, Infrastructure/Redis, ...) across all docs.
- Replace the removed autoload.php references with vendor/autoload.php
  (build_system, bootstrap-contexts, error-handling, modules).
- ssl-generation: note that the installer now auto-generates a unique self-signed
  certificate before Nginx starts.

Common pattern (Clean & uniform):
- Strip emoji from headings; remove the in-page Navigation blocks (the Docsify
  sidebar already provides navigation).
- One H1 + intro per doc; uniform "Related files" / "Связанные файлы" section,
  added to the code-centric docs that lacked it.

Structure:
- Remove the empty stray docs/api/; move updates_checklist.md into builds/;
  link the previously-orphaned ucs-integration.md.
- Regroup the sidebars (split the oversized guides group into Developer Guides /
  Security & Access / Integrations; fold builds into Build & Release).

Augment:
- dev-workflow: Local Setup (make dev-tools) + Quality Checks (phpstan, cs, gates).
- build_system: Composer Dependencies section (committed prod-only vendor,
  committed lock, dev tools via composer install, no build-time vendor step).

en/ru parity:
- Apply the same structure, fixes and pattern to docs/ru/ (translated), including
  a new Russian ucs-integration.md. The en and ru file sets are now identical.

2026-06-26 15:56:15 +03:00

5.5 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 в репозитории.

5.5 KiB Raw Blame History