mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-03 04:02:10 +02:00
32 lines
3.6 KiB
Markdown
32 lines
3.6 KiB
Markdown
# Интерактивная ссылка на API (Swagger)
|
|
|
|
Интерактивный, всегда синхронизируемый пользовательский интерфейс Swagger для каждого XC_VM API, созданный на основе спецификаций OpenAPI версии 3.0. Используйте вкладки API в верхней части страницы для переключения между API или откройте один из них напрямую по ссылкам ниже.
|
|
|
|
|интерфейс прикладного программирования|Описание|Автор|Открыть|
|
|
| --- | --- | --- | --- |
|
|
|**API администратора**|XUI.ONE-совместимое администрирование — линии, пользователи, потоки, VOD, серии, серверы, настройки (104 конечные точки)|`api_key` + код доступа|[Открыть ↗](../../_media/swagger-ui.html?spec=admin)|
|
|
|**Системный API**|Внутренний `/api.php` — поток/VOD управление, статистика, процессы, файлы, подключения (31 действие)|`password` (`live_streaming_pass`)|[Открыть ↗](../../_media/swagger-ui.html?spec=system)|
|
|
|**API для игроков**|Проигрыватель XtreamCodes — Прямые трансляции, VOD, Сериалы, EPG|`username` + `password`|[Открыть ↗](../../_media/swagger-ui.html?spec=player)|
|
|
|**API списка воспроизведения**|`/playlist` аутентификация + создание списка воспроизведения|`username`/`password` или `token`|[Открыть ↗](../../_media/swagger-ui.html?spec=playlist)|
|
|
|
|
---
|
|
|
|
## Используя "Попробуй это"
|
|
|
|
1. Откройте спецификацию, затем используйте вкладки **API** для переключения API и вкладки **Документация / Интерактивные (Swagger)** для каждого API.
|
|
2. Разверните любую конечную точку → ** Попробуйте ** → заполните параметры → ** Выполните**, чтобы увидеть реальный URL-адрес запроса, команду cURL и оперативный ответ.
|
|
3. Чтобы получить доступ к API администратора, нажмите "Авторизоваться" и вставьте свой API—ключ - затем он автоматически прикрепляется к каждому запросу.
|
|
|
|
> ** Примечание CORS:** CORS может заблокировать прямые вызовы "Попробуйте" из браузера на ваш сервер. Это ожидаемо — вместо этого используйте сгенерированную команду cURL, Postman или Insomnia. Ошибка не означает, что API не работает.
|
|
|
|
---
|
|
|
|
## Исходные технические характеристики
|
|
|
|
Каждая спецификация может быть импортирована в Postman, Insomnia или любой другой инструментарий OpenAPI версии 3.0:
|
|
|
|
- [`admin-api.openapi.yaml`](../../_media/admin-api.openapi.yaml)
|
|
- [`system-api.openapi.yaml`](../../_media/system-api.openapi.yaml)
|
|
- [`player-api.openapi.yaml`](../../_media/player-api.openapi.yaml)
|
|
- [`playlist-api.openapi.yaml`](../../_media/playlist-api.openapi.yaml)
|