mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-10-13 04:03:02 +02:00
Divarion_D
bdbcde97c7
CI translation was slow, so move it out of GitHub Actions: docs/ru is now a committed, generated tree refreshed LOCALLY before a release; CI only builds it. - pages.yml: drop the setup-python/cache/translate steps — the workflow now just installs the build toolchain and runs `mkdocs build --strict` on the committed en+ru trees. - .gitignore: stop ignoring docs/ru (now committed); keep site/ + .docs-cache/. - Split deps: docs/requirements.txt = build only (mkdocs-material, static-i18n, used by CI); tools/docs/requirements.txt = translators (local-only). - Makefile: docs-venv installs both; docs-build/docs-serve no longer translate (translation is the deliberate `make docs-translate` release step). - updates_checklist.md: new "Regenerate translated documentation" step (make docs-translate + docs-build, commit docs/ru with the release commit). - Commit the generated docs/ru (37 files, translators/yandex). Rule: edit ONLY docs/en; docs/ru is generated — never hand-edit it.
3.5 KiB
3.5 KiB
Интерактивная ссылка на API (Swagger)
Интерактивный, всегда синхронизированный пользовательский интерфейс Swagger для каждого XC_VM API, созданный на основе спецификаций OpenAPI 3.0. Используйте вкладки API в верхней части страницы для переключения между API или откройте один из них напрямую по ссылкам ниже.
| интерфейс прикладного программирования | Описание | Автор | Открыть |
|---|---|---|---|
| API администратора | XUI.ONE-совместимое администрирование — линии, пользователи, потоки, VOD, серии, серверы, настройки (104 конечные точки) | api_key + код доступа |
Открыть ↗ |
| Системный API | Внутренний /api.php — поток/VOD управление, статистика, процессы, файлы, подключения (31 действие) |
password (live_streaming_pass) |
Открыть ↗ |
| API для игроков | Проигрыватель XtreamCodes — Прямой эфир, VOD, Серия, EPG | username + password |
Открыть ↗ |
| API списка воспроизведения | /playlist аутентификация + создание списка воспроизведения |
username/password или token |
Открыть ↗ |
Используя "Попробуй это"
- Откройте спецификацию, затем используйте вкладки API для переключения API и вкладки Документация / Интерактивные (Swagger) для каждого API.
- Разверните любую конечную точку → ** Попробуйте ** → заполните параметры → ** Выполните**, чтобы увидеть реальный URL запроса, команду cURL и оперативный ответ.
- Чтобы получить доступ к API администратора, нажмите "Авторизоваться" и вставьте свой API—ключ - затем он автоматически прикрепляется к каждому запросу.
** Примечание CORS:** CORS может заблокировать прямые вызовы "Попробуйте" из браузера на ваш сервер. Это ожидаемо — вместо этого используйте сгенерированную команду cURL, Postman или Insomnia. Ошибка не означает, что API не работает.
Исходные технические характеристики
Каждая спецификация может быть импортирована в Postman, Insomnia или любой другой инструментарий OpenAPI 3.0: