# VARGO Partner API

> API VPN-франшизы VARGO — когда хотите сделать по-своему: всё, что нужно для продажи VPN, в вашем коде. Бот, приложение, сайт или свой продукт — решаете вы.

- [Обзор](https://vargopartners.com/docs/index.md): API VPN-франшизы VARGO: вся платформа в вашем коде — бот, приложение, сайт или свой продукт
- [Начало работы](https://vargopartners.com/docs/getting-started.md): Ключ, id клиента, повтор запроса без второго счёта, язык ответов
- [Перед запуском](https://vargopartners.com/docs/onboarding.md): Что проверить до первых клиентов и куда писать, если что-то не так
- [Тарифы и деньги](https://vargopartners.com/docs/pricing.md): Из чего складывается цена, как проходит оплата и куда ложится наценка
- [Клиент и подключение](https://vargopartners.com/docs/clients.md): Подписка клиента, экран подключения, устройства, документы и мини-апп
- [Вебхуки](https://vargopartners.com/docs/webhooks.md): События об оплате, истёкшем счёте и окончании подписки на ваш сервер
- [Ошибки и лимиты](https://vargopartners.com/docs/errors.md): Коды ошибок, что делать с каждым, лимиты запросов и версии
- [Все эндпоинты](https://vargopartners.com/docs/api/overview.md): Что умеет API — одной таблицей
- [Аккаунт партнёра](https://vargopartners.com/docs/api/account.md): Название сервиса, наценка, ссылка поддержки и включён ли пробный период. Удобная первая проверка ключа: неверный ключ — `401 UNAUTHORIZED`.
- [Изменить название и наценку](https://vargopartners.com/docs/api/update-account.md): Меняет только переданные поля: `brand_name` — название, которое видят ваши клиенты в документах и в VPN-приложении (по умолчанию VARGO); `markup_percent` — наценка к цене платформы, после неё `GET /plans` сразу отдаёт новые цены, а уже выставленные счета не меняются; `support_link` — поддержка в VPN…
- [Тарифы](https://vargopartners.com/docs/api/plans.md): Тарифы и доп. устройства с ценами для клиента: цена платформы плюс наценка API, которую задаёт `PATCH /account`. Формула та же, что в ваших Telegram-ботах на платформе, но наценка у API своя. `plan_id` отсюда передаётся в `POST /payments`.
- [Способы оплаты](https://vargopartners.com/docs/api/payment-methods.md): Способы, доступные клиенту прямо сейчас; `method` отсюда передаётся в `POST /payments`. Список меняется — перечитывайте его перед показом клиенту.
- [Документы клиента](https://vargopartners.com/docs/api/documents.md): Ссылки на пользовательское соглашение и политику конфиденциальности под названием сервиса партнёра. Показывайте их клиенту до оплаты. Текст ведёт платформа, страницы открываются без ключа; заголовки — на языке из `Accept-Language`.
- [Выставить счёт](https://vargopartners.com/docs/api/create-payment.md): Счёт на подписку (`purpose: subscription` и `plan_id`) или на доп. устройства (`purpose: devices` и `devices`). Клиента нет — заводится. Продление — тот же вызов на тот же `client_id`: срок прибавляется к текущему, ссылка подписки не меняется. Ссылку `payment_url` отдайте клиенту, результат оплаты —…
- [Счёт](https://vargopartners.com/docs/api/get-payment.md): Текущее состояние счёта; после оплаты в `client` — клиент со ссылкой подписки. Это источник истины: перед выдачей доступа у себя перечитайте счёт. `expired` не окончательный — поздняя оплата переводит счёт в `succeeded`.
- [Клиент](https://vargopartners.com/docs/api/get-client.md): Статус и срок подписки, ссылка подписки и готовые ссылки подключения. Клиент появляется с первым счётом или пробным периодом, до этого — `404 API_CLIENT_NOT_FOUND`. Клиент, заблокированный платформой, — `403 API_CLIENT_BLOCKED` на всех ручках клиента.
- [VPN-приложения](https://vargopartners.com/docs/api/apps.md): Для экрана «Как подключиться»: платформы, приложения со ссылками на установку и рекомендованное приложение. `app_id` совпадает с `subscription.connect[].app_id` клиента. Подписи — на языке из `Accept-Language` (`ru` или `en`, без заголовка — `en`).
- [Пробный период](https://vargopartners.com/docs/api/start-trial.md): Выдаёт пробный период; он включён по умолчанию (`trial_enabled` в `GET /account`). Клиента нет — заводится. Ответ — клиент со ссылкой подписки. Отказы: `403 TRIAL_DISABLED` — пробный период выключен платформой; `409 TRIAL_ALREADY_USED` — у клиента уже была подписка; `503 SERVICE_UNAVAILABLE` — пробн…
- [Список клиентов](https://vargopartners.com/docs/api/list-clients.md): Клиенты партнёра постранично, свежие первыми. Фильтр `status` — по подписке: `active`, `expired`, `suspended` — как `subscription.status`; `none` — подписки не было ни разу.
- [Устройства клиента](https://vargopartners.com/docs/api/list-devices.md): Подключённые устройства и лимит. Без подписки список пуст. Если платформа не ответила — `503 SERVICE_UNAVAILABLE`, а не пустой список: пустой ответ всегда значит «устройств нет».
- [Удалить устройство](https://vargopartners.com/docs/api/delete-device.md): Отключает устройство и освобождает место под новое. `device_id` — из `GET …/devices`, в пути URL-кодированный. Ответ — обновлённый список, как у `GET`. Такого устройства нет — `404 DEVICE_NOT_FOUND`.
- [Перевыпустить ссылку подписки](https://vargopartners.com/docs/api/rotate-link.md): Новая ссылка подписки; старая сразу перестаёт работать, и клиент добавляет подписку в приложение заново. Не чаще раза в час на клиента: иначе `429 LINK_ROTATE_TOO_SOON`, пауза в секундах — в заголовке `Retry-After`. Без действующей подписки — `400 NO_ACTIVE_SUBSCRIPTION`.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.