mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-09-28 12:02:04 +02:00
Divarion-D
76844fef11
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.
501 lines
15 KiB
Markdown
501 lines
15 KiB
Markdown
# XtreamCodes API
|
|
|
|
API предоставляет доступ к IPTV-потокам (Live TV, Радио), VOD (фильмы), сериалам и EPG (телепрограмма) в приложениях, совместимых с XtreamCodes. Это ключевой компонент для интеграции с XC_VM.
|
|
|
|
---
|
|
|
|
## Расположение файлов
|
|
|
|
Основной API обрабатывается `PlayerApiController`:
|
|
|
|
```text
|
|
src/Public/Controllers/Api/PlayerApiController.php
|
|
```
|
|
|
|
EPG/XMLTV эндпоинт (`/xmltv.php`) обрабатывается `EpgApiController`:
|
|
|
|
```text
|
|
src/Public/Controllers/Api/EpgApiController.php
|
|
```
|
|
|
|
---
|
|
|
|
## Содержание
|
|
|
|
API разделен на ключевые разделы для удобства интеграции. Каждый эндпоинт описан с примерами запросов и ответов.
|
|
|
|
---
|
|
|
|
## Авторизация
|
|
|
|
Авторизация — первый шаг для доступа к контенту. Она подтверждает учетные данные пользователя и возвращает информацию о сервере.
|
|
|
|
### Запрос
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}
|
|
```
|
|
|
|
### Пример ответа
|
|
|
|
```json
|
|
{
|
|
"user_info": {
|
|
"username": "testxc",
|
|
"password": "testxc",
|
|
"message": "Welcome to XC_VM",
|
|
"auth": 1,
|
|
"status": "Active",
|
|
"exp_date": null,
|
|
"is_trial": 0,
|
|
"created_at": 1757353729,
|
|
"max_connections": 1,
|
|
"allowed_output_formats": [
|
|
"m3u8",
|
|
"ts",
|
|
"rtmp"
|
|
]
|
|
},
|
|
"server_info": {
|
|
"xui": true,
|
|
"version": "1.1.0",
|
|
"url": "176.124.192.118",
|
|
"port": "80",
|
|
"https_port": "443",
|
|
"server_protocol": "http",
|
|
"rtmp_port": "8880",
|
|
"timestamp_now": 1757442189,
|
|
"time_now": "2025-09-09 19:23:09",
|
|
"timezone": "Europe/London"
|
|
}
|
|
}
|
|
```
|
|
|
|
> 💡 **Совет:** Используйте полученные данные для последующих запросов, чтобы избежать повторной авторизации.
|
|
|
|
---
|
|
|
|
## Live TV (ТВ и Радио)
|
|
|
|
Раздел для работы с живыми трансляциями, включая категории, стримы и EPG.
|
|
|
|
### Получить все категории Live
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_live_categories
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
[
|
|
{
|
|
"category_id": "1",
|
|
"category_name": "News",
|
|
"parent_id": 0
|
|
},
|
|
{
|
|
"category_id": "2",
|
|
"category_name": "Sports",
|
|
"parent_id": 0
|
|
}
|
|
]
|
|
```
|
|
|
|
### Получить все Live-стримы
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_live_streams
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
[
|
|
{
|
|
"num": 1,
|
|
"name": "BBC News",
|
|
"stream_type": "live",
|
|
"stream_id": 101,
|
|
"stream_icon": "http://176.124.192.118/images/bbc.png",
|
|
"epg_channel_id": "bbc.news.uk",
|
|
"added": "1660568200",
|
|
"category_id": "1",
|
|
"custom_sid": "",
|
|
"tv_archive": 0,
|
|
"direct_source": "",
|
|
"tv_archive_duration": 0
|
|
}
|
|
]
|
|
```
|
|
|
|
### Получить стримы категории
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_live_streams&category_id={id}
|
|
```
|
|
|
|
### Получить EPG канала (краткая программа)
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_short_epg&stream_id={id}&limit={N}
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
{
|
|
"epg_listings": [
|
|
{
|
|
"id": 1,
|
|
"title": "Morning News",
|
|
"start": "2022-08-15 07:00:00",
|
|
"end": "2022-08-15 08:00:00",
|
|
"description": "Daily morning news update."
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Получить полную программу канала
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_simple_data_table&stream_id={id}
|
|
```
|
|
|
|
### EPG для всех каналов (XMLTV)
|
|
|
|
```http
|
|
GET /xmltv.php?username={username}&password={password}
|
|
```
|
|
|
|
#### Пример ответа (XMLTV)
|
|
|
|
```xml
|
|
<tv>
|
|
<channel id="bbc.news.uk">
|
|
<display-name>BBC News</display-name>
|
|
</channel>
|
|
<programme start="20220815070000 +0000" stop="20220815080000 +0000" channel="bbc.news.uk">
|
|
<title>Morning News</title>
|
|
<desc>Daily morning news update.</desc>
|
|
</programme>
|
|
</tv>
|
|
```
|
|
|
|
---
|
|
|
|
## VOD (Фильмы)
|
|
|
|
Раздел для видео по запросу, включая категории и информацию о фильмах.
|
|
|
|
### Категории фильмов
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_vod_categories
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
[
|
|
{
|
|
"category_id": "10",
|
|
"category_name": "Action",
|
|
"parent_id": 0
|
|
},
|
|
{
|
|
"category_id": "11",
|
|
"category_name": "Drama",
|
|
"parent_id": 0
|
|
}
|
|
]
|
|
```
|
|
|
|
> ⚠️ **Примечание:** Полный список категорий может быть большим; в примерах показаны только фрагменты.
|
|
|
|
### Получить все VOD-стримы
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_vod_streams
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
[
|
|
{
|
|
"num": 1,
|
|
"name": "The Dark Knight (2008)",
|
|
"title": "The Dark Knight",
|
|
"year": 2008,
|
|
"stream_type": "movie",
|
|
"stream_id": 1,
|
|
"stream_icon": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljuWhs_Jbsg3Nu1tBcV0ErgPL_v9ei3c1fI0mNI7C5eos.jpg",
|
|
"rating": 8.5,
|
|
"rating_5based": 4.3,
|
|
"added": 1757343129,
|
|
"plot": "Batman raises the stakes in his war on crime. With the help of Lt. Jim Gordon and District Attorney Harvey Dent, Batman sets out to dismantle the remaining criminal organizations that plague the streets. The partnership proves to be effective, but they soon find themselves prey to a reign of chaos unleashed by a rising criminal mastermind known to the terrified citizens of Gotham as the Joker.",
|
|
"cast": "Christian Bale, Heath Ledger, Aaron Eckhart, Michael Caine, Maggie Gyllenhaal",
|
|
"director": "Christopher Nolan, Christopher Nolan, Steve Gehrke",
|
|
"genre": "Drama, Action, Crime",
|
|
"release_date": "2008-07-16",
|
|
"youtube_trailer": "kmJLuwP3MbY",
|
|
"episode_run_time": "152",
|
|
"category_id": "1",
|
|
"category_ids": [1, 2],
|
|
"container_extension": "mp4",
|
|
"custom_sid": "",
|
|
"direct_source": ""
|
|
}
|
|
]
|
|
```
|
|
|
|
---
|
|
|
|
### Фильмы по категории
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_vod_streams&category_id={id}
|
|
```
|
|
|
|
### Информация о фильме
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_vod_info&vod_id={id}
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
{
|
|
"info": {
|
|
"kinopoisk_url": "https://www.themoviedb.org/movie/155",
|
|
"tmdb_id": 155,
|
|
"name": "The Dark Knight",
|
|
"o_name": "The Dark Knight",
|
|
"cover_big": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljuWhs_Jbsg3Nu1tBcV0ErgPL_v9ei3c1fI0mNI7C5eos.jpg",
|
|
"movie_image": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljuWhs_Jbsg3Nu1tBcV0ErgPL_v9ei3c1fI0mNI7C5eos.jpg",
|
|
"release_date": "2008-07-16",
|
|
"episode_run_time": 152,
|
|
"youtube_trailer": "kmJLuwP3MbY",
|
|
"director": "Christopher Nolan, Christopher Nolan, Steve Gehrke",
|
|
"actors": "Christian Bale, Heath Ledger, Aaron Eckhart, Michael Caine, Maggie Gyllenhaal",
|
|
"cast": "Christian Bale, Heath Ledger, Aaron Eckhart, Michael Caine, Maggie Gyllenhaal",
|
|
"description": "Batman raises the stakes in his war on crime. With the help of Lt. Jim Gordon and District Attorney Harvey Dent, Batman sets out to dismantle the remaining criminal organizations that plague the streets. The partnership proves to be effective, but they soon find themselves prey to a reign of chaos unleashed by a rising criminal mastermind known to the terrified citizens of Gotham as the Joker.",
|
|
"plot": "Batman raises the stakes in his war on crime. With the help of Lt. Jim Gordon and District Attorney Harvey Dent, Batman sets out to dismantle the remaining criminal organizations that plague the streets. The partnership proves to be effective, but they soon find themselves prey to a reign of chaos unleashed by a rising criminal mastermind known to the terrified citizens of Gotham as the Joker.",
|
|
"age": "",
|
|
"mpaa_rating": "",
|
|
"rating_count_kinopoisk": 0,
|
|
"country": "United Kingdom",
|
|
"genre": "Drama, Action, Crime",
|
|
"backdrop_path": [
|
|
"http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCADBzwKB171qpiTTqrZdeATVLqPvNOO1tw6QZZproFAJRjrtA4EzIxoMJZlI2R3OlQ.jpg"
|
|
],
|
|
"duration_secs": 9120,
|
|
"duration": "02:32:00",
|
|
"bitrate": 0,
|
|
"rating": 8.52,
|
|
"releasedate": "2008-07-16",
|
|
"subtitles": []
|
|
},
|
|
"movie_data": {
|
|
"stream_id": 1,
|
|
"name": "The Dark Knight (2008)",
|
|
"title": "The Dark Knight",
|
|
"year": 2008,
|
|
"added": 1757343129,
|
|
"category_id": "1",
|
|
"category_ids": [1, 2],
|
|
"container_extension": "mp4",
|
|
"custom_sid": "",
|
|
"direct_source": ""
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Сериалы
|
|
|
|
Раздел для работы с сериалами, включая категории, сезоны и эпизоды.
|
|
|
|
### Категории сериалов
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_series_categories
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
[
|
|
{
|
|
"category_id": "20",
|
|
"category_name": "Drama",
|
|
"parent_id": 0
|
|
}
|
|
]
|
|
```
|
|
|
|
---
|
|
|
|
### Все сериалы
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_series
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
[
|
|
{
|
|
"num": 1,
|
|
"name": "Braceface (2001)",
|
|
"title": "Braceface",
|
|
"year": 2001,
|
|
"stream_type": "series",
|
|
"series_id": 1,
|
|
"cover": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljpT6mCZeHa4zLXMQZ2eaTpGZUSOucptPKyuP5tgpEZm0.jpg",
|
|
"plot": "The show, set in Elkford, British Columbia, is based around Sharon Spitz, who is a junior high school student with braces that get in her way of leading a normal teenage life. In the first season, she is enrolled at Mary Pickford Junior High.",
|
|
"cast": "Stacey DePass",
|
|
"director": "Charles E. Bastien",
|
|
"genre": "Drama, Animation, Comedy",
|
|
"release_date": "2001-06-02",
|
|
"releaseDate": "2001-06-02",
|
|
"last_modified": "1757348651",
|
|
"rating": "7",
|
|
"rating_5based": 3.5,
|
|
"backdrop_path": [
|
|
"http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCADBzwKB171qpiTTqrZdeATBaSzxZEgi9EPIvh5kU_50ecbH2L-yDt1PIfqijKTIMg.jpg"
|
|
],
|
|
"youtube_trailer": null,
|
|
"episode_run_time": 25,
|
|
"category_id": "4",
|
|
"category_ids": [4]
|
|
}
|
|
]
|
|
```
|
|
|
|
---
|
|
|
|
### Сериалы по категории
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_series&category_id={id}
|
|
```
|
|
|
|
### Информация о сериале
|
|
|
|
```http
|
|
GET /player_api?username={username}&password={password}&action=get_series_info&series_id={id}
|
|
```
|
|
|
|
#### Пример ответа
|
|
|
|
```json
|
|
{
|
|
"seasons": [
|
|
{
|
|
"air_date": "2001-06-02",
|
|
"episode_count": 26,
|
|
"id": 4937,
|
|
"name": "Season 1",
|
|
"overview": "",
|
|
"season_number": 1,
|
|
"vote_average": 4.5,
|
|
"cover": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljJBrZ7sNEJHE6hlqofFOJSRKiMRvSj08-T6iTQVWvj2I.jpg",
|
|
"cover_big": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljJBrZ7sNEJHE6hlqofFOJSRKiMRvSj08-T6iTQVWvj2I.jpg"
|
|
}
|
|
],
|
|
"info": {
|
|
"name": "Braceface (2001)",
|
|
"title": "Braceface",
|
|
"year": 2001,
|
|
"cover": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCLaoCzC2XshRjzbEF-0-ISX3OBAKZPN21ASjMFFF_OljpT6mCZeHa4zLXMQZ2eaTpGZUSOucptPKyuP5tgpEZm0.jpg",
|
|
"plot": "The show, set in Elkford, British Columbia, is based around Sharon Spitz, who is a junior high school student with braces that get in her way of leading a normal teenage life. In the first season, she is enrolled at Mary Pickford Junior High.",
|
|
"cast": "Stacey DePass",
|
|
"director": "Charles E. Bastien",
|
|
"genre": "Drama, Animation, Comedy",
|
|
"release_date": "2001-06-02",
|
|
"releaseDate": "2001-06-02",
|
|
"last_modified": "1757348651",
|
|
"rating": "7",
|
|
"rating_5based": 3.5,
|
|
"backdrop_path": [
|
|
"http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCADBzwKB171qpiTTqrZdeATBaSzxZEgi9EPIvh5kU_50ecbH2L-yDt1PIfqijKTIMg.jpg"
|
|
],
|
|
"youtube_trailer": null,
|
|
"episode_run_time": 25,
|
|
"category_id": "4",
|
|
"category_ids": [4]
|
|
},
|
|
"episodes": {
|
|
"1": [
|
|
{
|
|
"id": "2",
|
|
"episode_num": "1",
|
|
"title": "Braceface - S01E01 - Brace Yourself",
|
|
"container_extension": "mp4",
|
|
"info": {
|
|
"release_date": "2001-06-02",
|
|
"plot": "Sharon Spitz, a 13-year-old 8th grader get's braces the day before picture day. When getting braces at the ortadontist, there is a thunder storm and the power go's out. Something happens with Sharon's braces and now its making her do all sorts of weird things!",
|
|
"duration_secs": 649,
|
|
"duration": "00:10:49",
|
|
"movie_image": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCADBzwKB171qpiTTqrZdeARCK8Ch0a6wlNxuIHhbJ3c1Dg_AqkwSsH-qdpnCvcMsiy6U85vvi1bs1xDOddBeOEQ.jpg",
|
|
"bitrate": 2791,
|
|
"rating": "5",
|
|
"season": "1",
|
|
"tmdb_id": "105800",
|
|
"cover_big": "http://176.124.192.118:80/images/7pQr8EhEi05VXRmZc5QfCADBzwKB171qpiTTqrZdeARCK8Ch0a6wlNxuIHhbJ3c1Dg_AqkwSsH-qdpnCvcMsiy6U85vvi1bs1xDOddBeOEQ.jpg"
|
|
},
|
|
"subtitles": [],
|
|
"custom_sid": "",
|
|
"added": 1757348651,
|
|
"season": 1,
|
|
"direct_source": ""
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Получение медиаконтента
|
|
|
|
Получите прямые ссылки на медиафайлы после авторизации.
|
|
|
|
- **Live TV (канал):**
|
|
|
|
```http
|
|
http://176.124.192.118/live/{username}/{password}/{stream_id}.ts
|
|
```
|
|
|
|
- **Фильм (VOD):**
|
|
|
|
```http
|
|
http://176.124.192.118/movie/{username}/{password}/{vod_id}.mp4
|
|
```
|
|
|
|
- **Серия:**
|
|
|
|
```http
|
|
http://176.124.192.118/series/{username}/{password}/{episode_id}.mp4
|
|
```
|
|
|
|
> ⚠️ **Важно:** При первом запросе происходит редирект на `/auth/...` для авторизации, после чего отдаётся контент.
|
|
|
|
---
|
|
|
|
## Примечания
|
|
|
|
- **Форматы вывода:** Поддерживаются m3u8, ts, rtmp — выбирайте в зависимости от устройства.
|
|
- **Безопасность:** Все запросы требуют авторизации; мониторьте логи на предмет ошибок.
|
|
- **Интеграция:** Для тестирования используйте инструменты вроде Postman. В приложении реализуйте кэширование ответов для оптимизации.
|
|
|
|
> 💬 Если возникнут вопросы по интеграции, создайте issue в [репозитории](https://github.com/Vateron-Media/XC_VM/issues).
|
|
|
|
---
|