From d70b88bf81ff420e6fcace73fa6320b893deff76 Mon Sep 17 00:00:00 2001 From: Divarion-D Date: Thu, 11 Sep 2025 20:28:35 +0300 Subject: [PATCH] Updating documentation for obtaining playlists --- docs/en/api/{get.md => playlist.md} | 8 +++++--- docs/en/api/system_api.md | 2 +- docs/en/main-page.md | 2 +- docs/ru/api/{get.md => playlist.md} | 14 ++++++++------ docs/ru/api/system_api.md | 2 +- docs/ru/main-page.md | 2 +- 6 files changed, 17 insertions(+), 13 deletions(-) rename docs/en/api/{get.md => playlist.md} (91%) rename docs/ru/api/{get.md => playlist.md} (84%) diff --git a/docs/en/api/get.md b/docs/en/api/playlist.md similarity index 91% rename from docs/en/api/get.md rename to docs/en/api/playlist.md index d49a98b3..140da984 100644 --- a/docs/en/api/get.md +++ b/docs/en/api/playlist.md @@ -2,7 +2,7 @@ ## File location ``` -/home/xc_vm/wwwdir/get.php +/home/xc_vm/wwwdir/playlist.php ``` ## Overview @@ -13,7 +13,7 @@ The API requires either a username and password or a token for authentication. ### Base URL ``` -http://:25461/get.php +http://:80/playlist ``` ## Endpoints @@ -39,7 +39,9 @@ GET / **Example Request:** ```sh -curl -X GET "http://:25461/get.php?username=test&password=test&type=m3u_plus&output=hls&key=live" +curl -X GET "http://:80/playlist/username/password/type&output=hls&key=live" +or +curl -X GET "http://:80/playlist/token/type&output=hls&key=live" ``` **Response:** diff --git a/docs/en/api/system_api.md b/docs/en/api/system_api.md index ebdc540f..af045384 100644 --- a/docs/en/api/system_api.md +++ b/docs/en/api/system_api.md @@ -1,4 +1,4 @@ -# System API +# System API (Method verification required) ## File location ``` diff --git a/docs/en/main-page.md b/docs/en/main-page.md index a058743f..211cf319 100644 --- a/docs/en/main-page.md +++ b/docs/en/main-page.md @@ -3,7 +3,7 @@ ## API - [System API](api/system_api.md) -- [Get playlist](api/get.md) +- [Get playlist](api/playlist.md) - [Xtreamcodes](api/xtreamcodes_api.md) ## Build diff --git a/docs/ru/api/get.md b/docs/ru/api/playlist.md similarity index 84% rename from docs/ru/api/get.md rename to docs/ru/api/playlist.md index ea71054c..af0ab1a7 100644 --- a/docs/ru/api/get.md +++ b/docs/ru/api/playlist.md @@ -2,7 +2,7 @@ ## Расположение файла ``` -/home/xc_vm/wwwdir/get.php +/home/xc_vm/wwwdir/playlist.php ``` ## Обзор @@ -13,7 +13,7 @@ ### Базовый URL ``` -http://<ваш домен>:25461/get.php +http://<ваш домен>:80/playlist ``` ## Конечные точки @@ -30,16 +30,18 @@ GET / |------------|----------|----------|-------------| | username | string | Yes* | Имя пользователя для аутентификации (Обязательно, если не используется `token`). | | password | string | Yes* | Пароль для аутентификации (требуется, если `token` не используется). | -| токен | строка | Да* | Токен аутентификации (требуется, если `имя пользователя` и `пароль` не используются). | -| | type | string | No | Тип устройства (по умолчанию: `m3u_plus`). | +| token | строка | Да* | Токен аутентификации (требуется, если `имя пользователя` и `пароль` не используются). | +| type | string | No | Тип устройства (по умолчанию: `m3u_plus`). | | key | string | No | Тип контента (прямой эфир, фильмы, радио_потоки, сериалы)| | | output | string | No | Формат вывода (hls или m3u). | -| | nocache | boolean | Нет | Если true, отключается кэширование. | +| nocache | boolean | Нет | Если true, отключается кэширование. | **Пример запроса:** ``sh -curl -X GET "http://<ваш-домен>:25461/get.php?username=test&password=test&type=m3u_plus&output=hls&key=live" +curl -X GET "http://:80/playlist/username/password/type&output=hls&key=live" +or +curl -X GET "http://:80/playlist/token/type&output=hls&key=live" ``` **Ответ:** diff --git a/docs/ru/api/system_api.md b/docs/ru/api/system_api.md index 3cb80c9e..31cc47bb 100644 --- a/docs/ru/api/system_api.md +++ b/docs/ru/api/system_api.md @@ -1,4 +1,4 @@ -# Системный API +# Системный API (Требуется проверка методов) ## Расположение файлов ``` diff --git a/docs/ru/main-page.md b/docs/ru/main-page.md index fc709782..8758734f 100644 --- a/docs/ru/main-page.md +++ b/docs/ru/main-page.md @@ -3,7 +3,7 @@ ## API - [Системный API](api/system_api.md) -- [Получить плейлист](api/get.md) +- [Получить плейлист](api/playlist.md) - [Xtreamcodes](api/xtreamcodes_api.md) ## Сборка