Files
XC_VM/docs/ru/api/swagger.md
T

32 lines
3.5 KiB
Markdown
Raw Normal View History

# Интерактивная ссылка на API (Swagger)
Интерактивный, всегда синхронизированный Swagger Пользовательский интерфейс для каждого XC_VM API, созданный на основе спецификаций OpenAPI версии 3.0. Используйте **Вкладки API** вверху страницы для переключения между API или откройте один из них напрямую по ссылкам ниже.
|интерфейс прикладного программирования|Описание|Автор|Открыть|
| --- | --- | --- | --- |
| **Admin API** |XUI.ONE-совместимое администрирование — линии, пользователи, потоки, VOD, серии, серверы, настройки (104 конечные точки)|`api_key` + код доступа|[Открыть ↗](../../_media/swagger-ui.html?spec=admin)|
| **System API** |Внутренний `/api.php` — поток/VOD управление, статистика, процессы, файлы, соединения (31 действие)|`password` (`live_streaming_pass`)|[Открыть ↗](../../_media/swagger-ui.html?spec=system)|
| **Player API** |Проигрыватель XtreamCodes — Прямые трансляции, VOD, Сериалы, EPG|`username` + `password`|[Открыть ↗](../../_media/swagger-ui.html?spec=player)|
| **Playlist 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)