API

Общие сведения

URL API: https://happ-proxy.com (ниже используются относительные пути)
Формат ответа: application/json
Коды ответов: HTTP-код 200. Результат выполнения запрос в ответе в полях rc и msg.

Термины и сущности

provider_code — 8 символов [A-Za-z0-9]{8} (ID провайдера).
auth_key — 32 символа [-_A-Za-z0-9]{32} (ключ авторизации провайдера).
install_code — 12 символов [A-Za-z0-9]{12} (код установки).
domain_hash — 64 символа [a-z0-9]{64} (SHA-256 от домена подписки, в нижнем регистре).

Создать лимитированную ссылку

GET /api/add-install

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
install_limit (int, required) — от 1 до 100
install_code (string, optional) — 12 символов. Если не передан — будет сгенерирован
note (string, optional) — 255 символов

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", "install_code": "ABCDEF123456", "id": 33 }

Такой install_code уже существует:

{ "rc": 2, "msg": "Install code exists" }

Ошибка валидации/авторизации/лимитов:

{ "rc": 0, "msg": "Auth error | Install limit error | Max install code created | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/add-install?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&install_limit=10' \
  -H 'accept: application/json'

Изменить лимитированную ссылку

GET /api/update-install

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
id (number, required)
install_limit (int, optional) — от 1 до 100, если не указано - значение не меняется, значение не может быть меньше install_count
note (string, optional) — 255 символов, если не указано - значение не меняется
status (int, optional) — 5 - Disabled / 10 - Active, если не указано - значение не меняется

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", "install_code": "ABCDEF123456" }

Ошибка валидации/авторизации/лимитов:

{ "rc": 0, "msg": "Auth error | Install limit error | Install status error | Error save install | Install not found | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/update-install?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&id=33&status=10' \
  -H 'accept: application/json'

Получить список лимитированных ссылок

GET /api/list-install

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
id (number, optional) — если не передан возвращаются последние 5000 записей

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", 
  "data": [
    {
      "id": 1,
      "install_code": "INSTALLCODE1",
      "install_limit": 100,
      "install_count": 43,
      "status": 10,
      "note": null,
      "created_at": "2025-02-18 18:03:54"
    }, 
    {
      "id": 2,
      "install_code": "INSTALLCODE2",
      "install_limit": 100,
      "install_count": 100,
      "status": 10,
      "note": "Note",
      "created_at": "2025-02-18 18:05:54"
    } 
  ] 
}

Значения status:
- 5 - Disabled
- 10 - Active
Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/list-install?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234' \
  -H 'accept: application/json'

Получить список hwid по лимитированной ссылке

GET /api/list-hwid

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
install_code (string, required) — обязателен если не передан install_id
install_id (number, required) — обязателен если не передан install_code
hwid (string, optional) — если не передан возвращаются последние 5000 записей

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", 
  "data": [
    {
      "hwid": "4998793c-3ce5-4ac9-9dfa-0ef5417b00fa",
      "date": "2025-07-23 13:38:02",
      "device_name": "DESKTOP-4C6OAQN_x86_64"
    },
    {
      "hwid": "890877189e13ca8b",
      "date": "2025-05-15 13:41:49",
      "device_name": "SM-A528B"
    }
  ] 
}

Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | Install code error | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/list-hwid?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&install_code=INSTIDCODE01' \
  -H 'accept: application/json'

Удалить hwid по лимитированной ссылке

GET /api/delete-hwid

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
install_code (string, required) — обязателен если не передан install_id
install_id (number, required) — обязателен если не передан install_code
hwid (string, required)

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", "install_count": 42 }

Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | Invalid parameters | Install code error | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/delete-hwid?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&install_code=INSTIDCODE01&hwid=DEVICEHWID' \
  -H 'accept: application/json'

Привязать домен подписки к provider id

GET /api/add-domain

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
domain_name (string, optional) — описание домена в domain_hash. Если не передан — будет создан из domain_hash
domain_hash (string, required) — SHA-256 домена в нижнем регистре (64 hex)

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", "id": 33 }

Такой domain_hash уже существует:

{ "rc": 2, "msg": "Domain hash exists | Domain hash exists. State set to active", "id": 33 }

Ошибка валидации/авторизации/лимитов/сохранения:

{ "rc": 0, "msg": "Auth error | Domain hash error | Unknown error | Error save domain | Error change state to active" }

Пример

curl -X 'GET' '{url_api}/api/add-domain?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&domain_hash=005c4a974d8b94af421206f9ef34efebab39a7a4d25a81723933892a1fdf2e31&domain_name=sub.example.com' \
  -H 'accept: application/json'

Удалить домен от provider id

GET /api/delete-domain

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
id (number, required)

Ответы

Успешно:

{ "rc": 1, "msg": "Ok" }

Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | Domain save error | Domain not found | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/delete-domain?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&id=33' \
  -H 'accept: application/json'

Получить список доменов у provider id

GET /api/list-domain

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
id (number, optional) — если не передан возвращаются последние 5000 записей

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", 
  "data": [
    {
      "id": 1,
      "domain_name": "Domain1",
      "domain_hash": "41e5e446716d7577286255aa55fd03e3420510cb85f20b8968e7010c81aa5468",
      "status": 10,
      "created_at": "2025-02-19 22:50:33"
    },
    { 
      "id": 2,
      "domain_name": "Domain2",
      "domain_hash": "e9f29ba623b30632f120a6c338ce066685492f2d4fc9544507388b70691a2f17",
      "status": 5,
      "created_at": "2025-02-19 22:50:33"
    } 
  ] 
}

Значения status:
- 5 - Disabled
- 10 - Active
Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | Unknown error" }

Пример

curl -X 'GET' '{url_api}/api/list-domain?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234' \
  -H 'accept: application/json'

Общие запросы для PUSH-уведомлений и команды удалённого управления

Отмена уведомления или команды

GET /remote/cancel

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
id (number, required)

Правила:

Отменить можно только свою рассылку
Нельзя отменять менее чем за 10 минут до времени отправки

Ответы

Успешно:

{ "rc": 1, "msg": "Ok" }

Ошибка валидации/авторизации/лимитов/отмены:

{ "rc": 0, "msg": "Auth error | This feature requires an active subscription | Notification not found | Cannot cancel notification less than 10 minutes before scheduled time | Failed to cancel notification | Unknown error" }

Пример

curl -X GET '{url_api}/remote/cancel?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&id=10' \
  -H 'accept: application/json'

Список уведомлений и команд

GET /remote/list

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа
id (number, optional) — если не передан возвращаются последние 5000 записей

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", 
  "data": [ 
    {
      "id": 585,
      "target_os": null,
      "target_hwid": "e2a1b20d417fdf9e",
      "status": 100,
      "created_at": "2025-11-18 23:20:22",
      "sent_at": "2025-11-18 23:21:02",
      "notification_type": 20
    },
    {
      "id": 584,
      "target_os": null,
      "target_hwid": "e2a1b20d417fdf9e",
      "status": 110,
      "created_at": "2025-11-18 23:19:24",
      "sent_at": "2025-11-18 23:20:01",
      "notification_type": 20
    }
  ] 
}

Значения status:
- 5 / 6 - Load
- 10 - Created
- 20 - Checking
- 30 - Pending
- 40 - Sending
- 100 - Sent
- 110 - Sent with errors
- 120 - Failed
- 130 - Cancelled
- 140 - Blocked
Значения notification_type:
- 10 - Push
- 20 - Command
Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | This feature requires an active subscription | Notification not found | Cannot cancel notification less than 10 minutes before scheduled time | Failed to cancel notification | Unknown error" }

Пример

curl -X GET '{url_api}/remote/list?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234&id=10' \
  -H 'accept: application/json'

Массовые PUSH-уведомления

Отправить PUSH-уведомление

POST /remote/notification

Доступ: требуется активная подписка и тариф Enterprise

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа

Body (Простой JSON)

{
  "PushNotificationForm": {
    "body": "Please update your app to the latest version",
    "type_push": "optional",
    "expire_days": 7
  },
  "os": ["android"]
}

Body (Расширенный JSON)

{
  "PushNotificationForm": {
    "title": "Default title",
    "body": "Default body",
    "link_for_open": "https://example.com/",
    "background_image": "https://example.com/image.jpg",
    "locales": {
      "RU": {
        "title": "Важное обновление",
        "body": "Пожалуйста, обновите приложение до последней версии",
        "link-for-open": "https://example.com/?ru"
      },
      "EN": {
        "title": "Important Update",
        "body": "Please update your app to the latest version",
        "link-for-open": "https://example.com/?en"
      },
      "CN": {
        "title": "Important Update",
        "body": "Please update your app to the latest version",
        "link-for-open": "https://example.com/?cn"
      },
      "FA": {
        "title": "Important Update",
        "body": "Please update your app to the latest version",
        "link-for-open": "https://example.com/?fa"
      }
    },
    "type_push": "force",
    "expire_days": 7,
    "send_date": "2025-12-31",
    "send_time": "23:59"
  },
  "os": ["android", "ios"],
  "hwid": "HWID1,HWID2"
}

Ограничения и валидация

Тело сообщения сериализуется как JSON и кодируется base64; размер base64-строки ≤ 4096 байт.
Если отправка не по конкретным HWID, действует антиспам: не чаще 1 раза в 5 минут на «общую» рассылку.
VPN провайдер:
- с hwid — HWID должны принадлежать пользователю.
- с os — рассылка только по устройствам пользователя с указанной OS

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", "id": 10 }

Ошибка валидации/авторизации/лимитов/сохранения:

{ "rc": 0, "msg": "Auth error | This feature requires an active subscription | This feature requires Enterprise plan | You can send general notifications only once every 5 minutes | Message too large (max 4096 bytes) | Device with this HWID not found | No devices found for selected OS and your provider IDs | Failed to save notification | Unknown error" }

Пример

curl -X POST '{url_api}/remote/notification?provider_code=Ab12Cd34&auth_key=AbcdEfghIjklMnopQrstuVwxyz_1234' \
 -H 'Content-Type: application/json' \
 -d '{
 "PushNotificationForm": {
    "body": "Please update your app to the latest version",
    "type_push": "optional",
    "expire_days": 7
  },
  "os": ["android"]
 }'

Команды удалённого управления (Remote Control)

Отправить команду на устройство

POST /remote/command

Доступ: требуется активная подписка и тариф Pro или Enterprise

Query-параметры

provider_code (string, required) — 8 символов
auth_key (string, required) — 32 символа

Варианты Body (JSON)

Отправить данные для импорта

{
  "action_type": "import-data",
  "import_data": "raw string to import",
  "specific-device-toggle": false,
  "hwid": "HWID1,HWID2",
  "os": ["ios","android"]
}

Обновить все подписки

{
  "action_type": "update-subscription",
  "specific-device-toggle": true,
  "hwid": "HWID-ABC123"
}

Установить настройки

{
  "action_type": "set-settings",
  "settings": { "log_level": "info", "featureX": true },
  "specific-device-toggle": true,
  "hwid": "HWID-ABC123"
}

Параметры настройки приложения

Название параметра

Значения

fragmentation-enable

true /false

fragmentation-packets

"tlshello" / "1-3"

local-dns-enable

true /false

subscription-autoconnect

true /false

subscription-autoconnect-type

"lastused" / "lowestdelay"

ping-type

"proxy" / "tcp" / "icmp"

per-app-proxy-mode

"off" / "on" / "bypass"

Изменение подписки

{
  "action_type": "sub-change",
  "change_type": "domain", // domain | url 
  "change_value": "example.com",
  "specific-device-toggle": false,
  "os": ["ios","android"]
}

Валидация

specific-device-toggle=true ⇒ hwid обязателен.
Если не specific-device-toggle, то os должен быть непустым.
При set-settings — settings обязателен и должен быть корректным JSON.

Ответы

Успешно:

{ "rc": 1, "msg": "Ok", "id": 10 }

Ошибка валидации/авторизации:

{ "rc": 0, "msg": "Auth error | This feature requires an active subscription | HWID is required for specific device | Select at least one OS | Unknown error" }

Дополнительно

Разрешённые HTML-теги: a,b,big,blockquote,br,cite,del,dfn,div,em,i,img,li,p,s,small,span,strike,strong,sub,sup,tt,u,ul.
OS-значения: ios, android.

Краткая сводка валидаций по RegExp

Поле

Регулярка

provider_code

^[A-Za-z0-9]{8}$

auth_key

^[-_A-Za-z0-9]{32}$

install_code

^[A-Za-z0-9]{12}$

domain_hash

^[a-z0-9]{64}$

PreviousProvider ID NextVPN Аукцион

Last updated 18 days ago

hashtagОбщие сведения

hashtagТермины и сущности

hashtagСоздать лимитированную ссылку

hashtagИзменить лимитированную ссылку

hashtagПолучить список лимитированных ссылок

hashtagПолучить список hwid по лимитированной ссылке

hashtagУдалить hwid по лимитированной ссылке

hashtagПривязать домен подписки к provider id

hashtagУдалить домен от provider id

hashtagПолучить список доменов у provider id

hashtagОбщие запросы для PUSH-уведомлений и команды удалённого управления

hashtagОтмена уведомления или команды

hashtagСписок уведомлений и команд

hashtagМассовые PUSH-уведомления

hashtagОтправить PUSH-уведомление

hashtagКоманды удалённого управления (Remote Control)

hashtagОтправить команду на устройство

Общие сведения

Термины и сущности

Создать лимитированную ссылку

Изменить лимитированную ссылку

Получить список лимитированных ссылок

Получить список hwid по лимитированной ссылке

Удалить hwid по лимитированной ссылке

Привязать домен подписки к provider id

Удалить домен от provider id

Получить список доменов у provider id

Общие запросы для PUSH-уведомлений и команды удалённого управления

Отмена уведомления или команды

Список уведомлений и команд

Массовые PUSH-уведомления

Отправить PUSH-уведомление

Команды удалённого управления (Remote Control)

Отправить команду на устройство