> ## Documentation Index
> Fetch the complete documentation index at: https://vargopartners.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Обзор

> API VPN-франшизы VARGO: вся платформа в вашем коде — бот, приложение, сайт или свой продукт

API даёт всё, что нужно для продажи VPN под вашим брендом. Во что это завернуть — бот, приложение, сайт или ваш собственный продукт — решаете вы. Всё, что клиент видит в своём кабинете, API отдаёт готовым: тарифы и оплату, статус подписки и срок, подключение, устройства.

Серверы, выдача доступа и приём оплаты остаются на платформе. Экраны и общение с клиентом — у вас.

## Что показать клиенту

| Экран | Откуда взять |
| - | - |
| Тарифы и цены | [`GET /plans`](https://vargopartners.com/docs/api/plans) |
| Оплата подписки или продления | [`POST /payments`](https://vargopartners.com/docs/api/create-payment) → ссылка `payment_url` |
| Подписка: активна ли, до какого числа, сколько дней осталось | [`GET /clients/{client_id}`](https://vargopartners.com/docs/api/get-client) → `subscription.status`, `expires_at`, `days_left` |
| Подключение: кнопка «Открыть в приложении» и QR-код | тот же ответ → `subscription.connect` |
| Устройства: сколько подключено из скольких, список с платформой и моделью | [`GET /clients/{client_id}/devices`](https://vargopartners.com/docs/api/list-devices) → `devices_count`, `devices_limit`, `devices` |
| Удалить устройство | [`DELETE /clients/{client_id}/devices/{device_id}`](https://vargopartners.com/docs/api/delete-device) |
| Докупить устройства | [`POST /payments`](https://vargopartners.com/docs/api/create-payment) с `purpose: devices` |
| Пробный период, если он у вас включён | [`POST /clients/{client_id}/trial`](https://vargopartners.com/docs/api/start-trial) |
| Перевыпустить ссылку подписки — старая сразу перестаёт работать | [`POST /clients/{client_id}/rotate-link`](https://vargopartners.com/docs/api/rotate-link) |
| Где скачать VPN-приложение | [`GET /apps`](https://vargopartners.com/docs/api/apps) |
| Соглашение и политика для клиента | [`GET /documents`](https://vargopartners.com/docs/api/documents) |

## Как устроены деньги

Клиент платит платформе на странице оплаты по ссылке из счёта. Цена для клиента — цена платформы плюс ваша наценка; после оплаты наценка ложится на ваш баланс партнёра. Подробно — [Тарифы и деньги](https://vargopartners.com/docs/pricing.md).

## Основное

| | |
| - | - |
| Базовый адрес | `https://api.vargopartners.com/api/partner/v1` |
| Формат | REST, JSON, UTF-8 |
| Ключ | `Authorization: Bearer vgo_live_…` на каждом запросе |
| Деньги | строки в рублях: `"150.00"`, рядом `currency: "RUB"` |
| Даты | ISO-8601, UTC |
| Ошибки | `{"error": {"code", "message", "fields"}}` — ветвиться по `code` |
| Язык текстов | заголовок `Accept-Language`: `ru` или `en`, без заголовка — `en` |
| События | [вебхуки](https://vargopartners.com/docs/webhooks.md) на ваш сервер: оплата, истёкший счёт, конец подписки |

> [!WARNING]
>
> Ключ живёт только на вашем сервере. Мини-апп и сайт ходят к вашему серверу, ваш сервер — к API. Ключ в коде мини-аппа достанется любому, кто его откроет, вместе со всеми вашими клиентами.

## Быстрый старт

**1. Выпустите ключ**

В кабинете партнёра откройте раздел [«API»](https://admin.vargopartners.com/reseller/api) и нажмите «Выпустить ключ». Значение `vgo_live_…` показывается один раз — сразу сохраните его на своём сервере. Подробно — [Начало работы](https://vargopartners.com/docs/getting-started.md).

**2. Проверьте ключ**

```bash theme={"dark"}
curl https://api.vargopartners.com/api/partner/v1/account \
  -H "Authorization: Bearer vgo_live_…"
```

В ответе — название вашего сервиса, наценка и ссылка поддержки. `401 UNAUTHORIZED` — ключ не принят. Наценка, пока её не задали, равна 0 — задайте её запросом [`PATCH /account`](https://vargopartners.com/docs/api/update-account) до первой продажи, иначе продажа идёт по цене платформы без вашего заработка.

**3. Возьмите тарифы и способы оплаты**

```bash theme={"dark"}
curl https://api.vargopartners.com/api/partner/v1/plans \
  -H "Authorization: Bearer vgo_live_…" \
  -H "Accept-Language: ru"

curl https://api.vargopartners.com/api/partner/v1/payment-methods \
  -H "Authorization: Bearer vgo_live_…" \
  -H "Accept-Language: ru"
```

Покажите клиенту `price` тарифа как есть — пересчитывать сумму у себя не нужно.

**4. Выставьте счёт**

```bash theme={"dark"}
curl -X POST https://api.vargopartners.com/api/partner/v1/payments \
  -H "Authorization: Bearer vgo_live_…" \
  -H "Idempotency-Key: order-1001" \
  -H "Content-Type: application/json" \
  -d '{"client_id": "user-42", "purpose": "subscription", "plan_id": 3, "method": "sbp", "return_url": "https://example.com/thanks"}'
```

Клиента `user-42` ещё нет — он заведётся этим счётом. Ответ `201`:

```json theme={"dark"}
{
  "payment_id": "5b0c9d0e-7c1a-4f3e-9b8e-2a6d1c0f4e21",
  "status": "pending",
  "purpose": "subscription",
  "client_id": "user-42",
  "plan_id": 3,
  "devices": null,
  "method": "sbp",
  "amount": "150.00",
  "platform_amount": "100.00",
  "partner_share": "50.00",
  "currency": "RUB",
  "payment_url": "https://…",
  "created_at": "2026-09-25T12:00:00Z",
  "expires_at": "2026-09-25T12:30:00Z",
  "paid_at": null,
  "client": null,
  "replayed": false
}
```

Отдайте клиенту `payment_url`.

**5. Дождитесь оплаты**

Пока клиент на странице оплаты, опрашивайте счёт:

```bash theme={"dark"}
curl https://api.vargopartners.com/api/partner/v1/payments/5b0c9d0e-7c1a-4f3e-9b8e-2a6d1c0f4e21 \
  -H "Authorization: Bearer vgo_live_…"
```

Когда `status` станет `succeeded`, в поле `client` придёт клиент со ссылкой подписки `subscription.subscription_url` и готовыми ссылками подключения `subscription.connect`.

Чтобы не опрашивать, подключите [вебхуки](https://vargopartners.com/docs/webhooks.md): событие `payment.succeeded` придёт на ваш сервер само.

**6. Подключите клиента**

Покажите кнопку «Открыть в приложении» (`connect[].connect_url`) или QR-код (`connect[].qr_payload`). Ссылки на установку приложений — `GET /apps`. Подробно — [Клиент и подключение](https://vargopartners.com/docs/clients.md).

## Дальше

> **[Начало работы](https://vargopartners.com/docs/getting-started.md)**
>
> Ключ, id клиента, повтор запроса, язык ответов

> **[Все эндпоинты](https://vargopartners.com/docs/api/overview.md)**
>
> Что умеет API — одной таблицей

> **[Клиент и подключение](https://vargopartners.com/docs/clients.md)**
>
> Подписка, экран подключения, устройства

> **[Вебхуки](https://vargopartners.com/docs/webhooks.md)**
>
> События об оплате и сроке подписки

> **[Ошибки и лимиты](https://vargopartners.com/docs/errors.md)**
>
> Коды ошибок, лимиты, версии

> **[Перед запуском](https://vargopartners.com/docs/onboarding.md)**
>
> Что проверить до первых клиентов


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