> ## 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.

# Аккаунт партнёра

> Название сервиса, наценка, ссылка поддержки и включён ли пробный период. Удобная первая проверка ключа: неверный ключ — `401 UNAUTHORIZED`.



## OpenAPI

````yaml GET /api/partner/v1/account
openapi: 3.1.0
info:
  title: VARGO Partner API
  version: '1.0'
  description: >-
    REST API для продажи VPN в своём боте, мини-аппе или на сайте: тарифы,
    счета, клиенты и их устройства. Клиент платит платформе, наценка партнёра
    начисляется на его баланс.


    Ключ партнёра — в заголовке `Authorization: Bearer vgo_live_…`, выпускается
    в кабинете партнёра, раздел «API». Ключ живёт только на сервере партнёра: в
    коде мини-аппа или сайта его быть не должно. Деньги — строки в рублях
    (`"150.00"`), даты — ISO-8601 UTC. Ошибки — `{error: {code, message,
    fields}}`: ветвиться по `code`, `message` клиенту не показывать.
servers:
  - url: https://api.vargopartners.com
security:
  - PartnerKey: []
paths:
  /api/partner/v1/account:
    get:
      tags:
        - Partner API
      summary: Аккаунт партнёра
      description: >-
        Название сервиса, наценка, ссылка поддержки и включён ли пробный период.
        Удобная первая проверка ключа: неверный ключ — `401 UNAUTHORIZED`.
      operationId: get_account_api_partner_v1_account_get
      responses:
        '200':
          description: Аккаунт партнёра
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiAccount'
        '401':
          description: >-
            Ключ не принят: `UNAUTHORIZED`. Неверный и отозванный ключ,
            выключенный доступ к API — один ответ
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            Запрос не прошёл проверку: `code` — `VALIDATION_ERROR`, в `fields` —
            поле и причина
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Превышен лимит запросов: `RATE_LIMITED` — повторить после паузы из
            `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          headers:
            Retry-After:
              description: >-
                Пауза в секундах до повтора; есть у `RATE_LIMITED` и
                `LINK_ROTATE_TOO_SOON`
              schema:
                type: integer
                minimum: 1
        default:
          description: >-
            Ошибка — тот же конверт; ветвиться по `code`, список кодов — в
            документации
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiAccount:
      properties:
        brand_name:
          type: string
          title: Brand Name
          description: >-
            Название вашего сервиса — его видят клиенты в документах и в
            VPN-приложении. По умолчанию VARGO, меняется запросом `PATCH
            /account`
        markup_percent:
          type: string
          title: Markup Percent
          description: Наценка к цене платформы, %; меняется запросом `PATCH /account`
          examples:
            - '50.00'
        support_link:
          anyOf:
            - type: string
            - type: 'null'
          title: Support Link
          description: >-
            Поддержка в VPN-приложении ваших клиентов; `null` — кнопки поддержки
            нет. Меняется запросом `PATCH /account`
          examples:
            - https://t.me/north_help
        trial_enabled:
          type: boolean
          title: Trial Enabled
          description: Пробный период через API включён
        currency:
          type: string
          title: Currency
          description: Валюта цен и сумм
          examples:
            - RUB
      type: object
      required:
        - brand_name
        - markup_percent
        - support_link
        - trial_enabled
        - currency
      title: ApiAccount
    ApiError:
      description: 'Конверт любой ошибки: статус HTTP плюс `error.code`.'
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
          description: Код, текст и поля ошибки
      required:
        - error
      title: ApiError
      type: object
    ApiErrorBody:
      properties:
        code:
          description: Машиночитаемый код ошибки — ветвиться по нему
          examples:
            - VALIDATION_ERROR
          title: Code
          type: string
        message:
          description: >-
            Текст для логов на языке из `Accept-Language` (`ru` или `en`);
            клиенту не показывать
          title: Message
          type: string
        fields:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          description: Поле → причина у `VALIDATION_ERROR`; у остальных ошибок `null`
          title: Fields
      required:
        - code
        - message
        - fields
      title: ApiErrorBody
      type: object
  securitySchemes:
    PartnerKey:
      type: http
      scheme: bearer
      description: >-
        Ключ партнёра `vgo_live_…`: выпускается в кабинете партнёра, раздел
        «API». Хранится только на сервере партнёра.

````

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