whmcs.php¶

Модуль интеграции с WHMCS для управления клиентами, счетами, кредитом, отменами заказов и биллинговыми данными серверов.

Методы API¶

Метод	Действие	Описание
`add_contact`	добавление контакта	Создает новый контакт в системе WHMCS
`apply_credit`	применение кредита к счету	Применяет доступный баланс клиента (кредит) для оплаты счета в WHMCS. Если счет оплачивается полностью, автоматически очищается перерасход трафика по связанным тегам.
`create_addfunds`	создание инвойса на пополнение баланса	Создает инвойс в WHMCS для пополнения баланса клиента (Add Funds). Поддерживает проверку минимальной суммы платежа и автоматическое включение подписки.
`delete_cancellation_request`	удаление запроса на отмену	Удаляет запрос на отмену для конкретного сервера, если он существует. Позволяет восстановить отмененный инвойс или сгенерировать новый.
`delete_contact`	удаление контакта клиента	Удаляет контактные данные пользователя из WHMCS и удаляет связь с организацией в локальной базе данных.
`download_invoice`	скачивание инвойса	Возвращает PDF-файл инвойса в формате base64 для просмотра или скачивания
`generate_due_invoice`	генерация счета на оплату	Генерирует следующий счет для сервера в WHMCS. Блокируется, если у сервера есть теги апгрейда или имеется неоплаченный инвойс.
`get_billing_data`	получение биллинговых данных сервера	Возвращает подробную информацию о биллинге конкретного сервера, включая данные клиента, статус EU-withdrawal и список лицензий для европейских клиентов.
`get_cancellation_requests`	получение списка запросов на отмену	Возвращает список активных запросов на отмену услуг (из WHMCS и Prebill) с фильтрацией по дате, типу отмены и статусу биллинга.
`get_client`	получение информации о клиенте	Возвращает подробную информацию о авторизованном клиенте из WHMCS, включая данные профиля, группу, внутренние теги и кастомные поля.
`get_clientgroups`	получение групп	Возвращает список доступных групп клиентов из WHMCS для указанной локации.
`get_contacts`	получение контактов	Возвращает список контактов клиента. Если указан subaccount, возвращается только соответствующий контакт с проверкой прав доступа.
`get_invoice`	получение данных счета	Возвращает детальную информацию о счете из WHMCS, включая данные клиента и валюту.
`get_invoices`	получение списка инвойсов клиента	Возвращает список счетов (инвойсов) для конкретного клиента WHMCS. Если запрос сделан от имени клиента, возвращаются только его счета.
`get_related_invoices`	получение связанных инвойсов	Возвращает список инвойсов, связанных с конкретным сервером или аккаунтом пользователя
`getcredits`	получение кредитов	Возвращает информацию о балансе (кредитах) пользователя в WHMCS для указанной локации.
`getpaymentgw`	получение платежных шлюзов	Возвращает список доступных платежных шлюзов для конкретного счета (invoice)
`mass_pay`	массовая оплата инвойсов	Создает массовый платеж по списку указанных ID инвойсов через WHMCS.
`request_cancellation`	запрос на отмену	Инициирует процесс автоматической или ручной отмены услуги в WHMCS с расчетом возврата средств, учетом трафика и налогов.
`request_subscription_cancellation`	запрос на отмену подписки	Инициирует процесс отмены подписки через создание тикета в JIRA и уведомление биллинга. Проверяет статус подписки в WHMCS и наличие открытых тикетов.
`reset_password`	сброс пароля	Инициирует процесс сброса пароля: отправляет ссылку на email или запрашивает 2FA код для подтверждения личности.
`transactions`	получение транзакций клиента	Возвращает список транзакций пользователя на основе предоставленного ID транзакции или инвойса
`update_client`	обновление данных клиента	Обновляет профиль клиента в WHMCS, включая персональные данные, контактную информацию, настройки 2FA и кастомные поля. Поддерживает проверку типов (компания/физлицо) и валидацию данных.
`update_contact`	обновление контактных данных	Обновляет информацию о контакте (имя, фамилия, email, телефон) в WHMCS. Поддерживает проверку пароля и валидацию полей в зависимости от локации.

whmcs/add_contact¶

Создает новый контакт в системе WHMCS

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_contact`
params[first_name]	✅	string	Имя контакта
params[last_name]	✅	string	Фамилия контакта
params[email]	✅	string	Электронная почта контакта
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=add_contact" \
--data "params[first_name]=VALUE" \
--data "params[last_name]=VALUE" \
--data "params[email]=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "add_contact",
"data": {
"contact_id": 12345,
"status": "active"
}
}

Примеры ошибок

``` { "code": -1, "message": "Ошибка при создании контакта" }

```

whmcs/apply_credit¶

Применяет доступный баланс клиента (кредит) для оплаты счета в WHMCS. Если счет оплачивается полностью, автоматически очищается перерасход трафика по связанным тегам.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `apply_credit`
invoice_id	✅	int	ID счета в WHMCS для оплаты
amount	✅	number	Сумма кредита для списания
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=apply_credit" \
--data "invoice_id=VALUE" \
--data "amount=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "success",
"invoiceid": 12345,
"amount": 10.0,
"status": "Paid"
}

Примеры ошибок

``` { "code": -1, "message": "invalid invoice id" }

```

whmcs/create_addfunds¶

Создает инвойс в WHMCS для пополнения баланса клиента (Add Funds). Поддерживает проверку минимальной суммы платежа и автоматическое включение подписки.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_addfunds`
amount	✅	number	Сумма пополнения баланса
subscribe	❌	boolean	Включить автоматические платежи банковской картой
description	❌	string	Описание для инвойса
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=create_addfunds" \
--data "amount=50.0" \
--data "token=YOUR_API_TOKEN"

Пример успешного ответа

{
"result": "OK",
"invoice": {
"id": 12345,
"amount": 50.0,
"currency": "USD",
"status": "unpaid",
"description": "Top up funds"
},
"message": "Invoice 12345 created"
}

Примеры ошибок

``` { "code": -1, "message": "$module/$action: invalid amount" }

```

whmcs/delete_cancellation_request¶

Удаляет запрос на отмену для конкретного сервера, если он существует. Позволяет восстановить отмененный инвойс или сгенерировать новый.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_cancellation_request`
token	✅	string	Авторизационный токен
id	✅	int	ID сервера для удаления запроса на отмену
full	❌	boolean	Если true, результат будет преобразован в 'OK' или 'Fail'

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=delete_cancellation_request" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "string",
"message": "string"
}

Примеры ошибок

``` { "code": -1, "message": "$module/$action: server $id doesn't have a relid data" }

```

whmcs/delete_contact¶

Удаляет контактные данные пользователя из WHMCS и удаляет связь с организацией в локальной базе данных.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_contact`
contact_id	✅	int	ID контакта для удаления
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=delete_contact" \
--data "contact_id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "success",
"action": "delete_contact",
"data": {
"clientid": 12345,
"status": "deleted",
"message": "Contact deleted successfully"
}
}

Примеры ошибок

``` { "code": -1, "message": "verification failed, subcontact not found" }

```

whmcs/download_invoice¶

Возвращает PDF-файл инвойса в формате base64 для просмотра или скачивания

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `download_invoice`
invoice_id	✅	int	ID инвойса в WHMCS
proforma_invoice	❌	boolean	Флаг использования проформы-инвойса
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=download_invoice" \
--data "invoice_id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "success",
"message": "base64_encoded_pdf_content"
}

Примеры ошибок

``` { "code": -1, "message": "undefined billing location" }

```

whmcs/generate_due_invoice¶

Генерирует следующий счет для сервера в WHMCS. Блокируется, если у сервера есть теги апгрейда или имеется неоплаченный инвойс.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
token	✅	string	API-токен аутентификации
id	✅	integer	ID сервера (из контекста вызова)

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345"

Пример успешного ответа

{
"result": "OK",
"invoices": [
{
"id": 12345,
"amount": 29.99,
"status": "Unpaid",
"due_date": "2024-06-01"
}
]
}

Примеры ошибок

``` { "code": -1, "message": "next_invoice_blocked_by_upgrade" }

```

whmcs/get_billing_data¶

Возвращает подробную информацию о биллинге конкретного сервера, включая данные клиента, статус EU-withdrawal и список лицензий для европейских клиентов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_billing_data`
id	✅	int	ID сервера
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_billing_data" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_billing_data",
"customer_name": "John Doe",
"eu_b2c": 1,
"eu_withdrawal": 0,
"eu_withdrawal_licenses": [
{
"name": "License A",
"amount": 49.99,
"currency": "EUR"
}
],
"billing_cycle": "monthly",
"customer": {
"email": "user@example.com",
"firstname": "John",
"lastname": "Doe"
},
"location": "US"
}

Примеры ошибок

``` { "code": -1, "message": "invalid request" }

```

whmcs/get_cancellation_requests¶

Возвращает список активных запросов на отмену услуг (из WHMCS и Prebill) с фильтрацией по дате, типу отмены и статусу биллинга.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_cancellation_requests`
id	❌	int	ID сервера для получения запросов по конкретному аккаунту. Если 0 или -1, поиск идет по пользователю/локации.
period_from	❌	string	Дата начала периода (формат даты)
period_to	❌	string	Дата окончания периода (формат даты)
cancellation_type	❌	string	Тип отмены. Значение 'All' игнорирует фильтр.
billing_status	❌	string	Статус биллинга. Значение 'All' игнорирует фильтр.
full	❌	boolean	Если true, возвращает расширенный результат (result: OK/Fail)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_cancellation_requests" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"message": [
{
"account_id": 123,
"due_date": "2024-05-20T10:00:00Z",
"cr_date": "2024-05-15",
"cr_reason": "User requested cancellation",
"cr_type": "subscription",
"billing_status": "active",
"name_client": "John Doe",
"customer_id": 45,
"corporate": "N",
"server_id": 101
}
]
}

Примеры ошибок

``` { "code": -1, "message": "WHMCS service is not linked to this server" }

```

whmcs/get_client¶

Возвращает подробную информацию о авторизованном клиенте из WHMCS, включая данные профиля, группу, внутренние теги и кастомные поля.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_client`
whmcs_id	❌	int	ID клиента в WHMCS (используется если клиент авторизован)
email	❌	string	Email для идентификации клиента
whmcs_location	❌	string	Локация биллинга (WHMCS location)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_client" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"client": {
"id": 123,
"email": "user@example.com",
"firstname": "John",
"lastname": "Doe",
"fullname": "John Doe",
"companyname": "Example Corp",
"phone": "+123456789",
"address1": "Street 1",
"city": "New York",
"state": "NY",
"countrycode": "US",
"postcode": "10001",
"groupid": 5,
"corporate": false,
"currency_code": "USD",
"ip": "127.0.0.1",
"location": "whmcs_us"
},
"billing_location": "whmcs_us",
"groupdata": {
"id": 5,
"name": "Premium Users"
},
"internal": {
"userid": 123,
"email": "user@example.com",
"billing_group": 5,
"corporate": false,
"currency": "USD"
}
}

Примеры ошибок

``` { "code": 502, "message": "Request failed for account@location: error_message" }

```

whmcs/get_clientgroups¶

Возвращает список доступных групп клиентов из WHMCS для указанной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_clientgroups`
location	✅	string	Локация биллинга (например, whmcs или COM)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_clientgroups" \
--data "location=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_clientgroups",
"data": {
"groups": [
{
"id": 1,
"groupname": "Standard Clients"
},
{
"id": 2,
"groupname": "VIP Clients"
}
]
}
}

Примеры ошибок

``` { "code": -1, "message": "invalid request" }

```

whmcs/get_contacts¶

Возвращает список контактов клиента. Если указан subaccount, возвращается только соответствующий контакт с проверкой прав доступа.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_contacts`
email	❌	string	Email дополнительного контакта (subaccount) для фильтрации списка
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_contacts" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_contacts",
"permission_contacts_granted": true,
"contacts": [
{
"email": "user@example.com",
"permissions": "contacts,billing",
"id": 123
}
]
}

Примеры ошибок

``` { "code": -1, "message": "$module/$action: fail to get contacts list" }

```

whmcs/get_invoice¶

Возвращает детальную информацию о счете из WHMCS, включая данные клиента и валюту.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_invoice`
invoice_id	✅	int	ID счета
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_invoice" \
--data "invoice_id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"status": "success",
"items": {
"item": [
{
"relid": 123,
"inv_id": 456
}
]
},
"currencycode": "USD",
"billing": "us",
"userid": 12345,
"client": {
"email": "user@example.com",
"status": "Active"
}
}

Примеры ошибок

``` { "code": -1, "message": "invalid invoice id 0 at US" }

```

whmcs/get_invoices¶

Возвращает список счетов (инвойсов) для конкретного клиента WHMCS. Если запрос сделан от имени клиента, возвращаются только его счета.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Название действия: `get_invoices`
token	✅	string	API-токен аутентификации
module	✅	string	Идентификатор модуля

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_invoices" \
--data "token=HOSTKEY_TOKEN" \
--data "module=VALUE"

Пример успешного ответа

{
"result": "OK",
"totalresults": 12,
"numreturned": 5,
"invoices": {
"invoice": [
{
"id": 1024,
"invoicenum": "INV-5501",
"date": "2024-05-01T10:00:00Z",
"duedate": "2024-06-01",
"total": 29.99,
"status": "Unpaid",
"currency": {
"USD": 29.99,
"EUR": 27.5
}
}
]
}
}

Примеры ошибок

``` { "code": -1, "message": "WHMCS billing response failed: error message" }

```

whmcs/get_related_invoices¶

Возвращает список инвойсов, связанных с конкретным сервером или аккаунтом пользователя

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_related_invoices`
account_id	❌	int	ID аккаунта для получения инвойсов
id	❌	int	ID сервера (если указан, используется его account_id)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=get_related_invoices" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"invoices": [
{
"id": 12345,
"userid": 678,
"total": 50.0,
"status": "Unpaid",
"date": "2024-05-20T10:00:00Z"
}
]
}

Примеры ошибок

``` { "code": -1, "message": "$module/get_related_invoices: invalid request" }

```

whmcs/getcredits¶

Возвращает информацию о балансе (кредитах) пользователя в WHMCS для указанной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `getcredits`
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=getcredits" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"message": {
"balance": 150.5,
"currency": "USD",
"last_transaction_date": "2024-05-20T12:00:00Z"
}
}

Примеры ошибок

``` { "code": -1, "message": "failed to retrive account history at US, please contact support - error_details" }

```

whmcs/getpaymentgw¶

Возвращает список доступных платежных шлюзов для конкретного счета (invoice)

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `getpaymentgw`
invoice_id	✅	int	ID инвойса в WHMCS
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=getpaymentgw" \
--data "invoice_id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"methods": {
"stripe": {
"call": "https://invapi.hostkey.com/pay?gateway=stripe&invoice_id=123"
},
"bitpay": {
"call": "https://invapi.hostkey.com/pay?gateway=bitpay&invoice_id=123"
},
"bitpaycheckout": {
"call": "/bitpay.php?action=init&token=$token"
},
"banktransfer": {
"call": "<span style='text-align:left'><p data-intl='please_wire_funds_in_favor'>Please wire funds in favor of:&nbsp;</p>...</span>"
}
}
}

Примеры ошибок

``` { "code": -1, "message": "invalid invoice id" }

```

whmcs/mass_pay¶

Создает массовый платеж по списку указанных ID инвойсов через WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `mass_pay`
invoices[]	✅	`array<int>`	Массив идентификаторов (ID) инвойсов для оплаты. Принимает несколько значений: invoices[]=1&invoices[]=2
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=mass_pay" \
--data "invoices[]=1" \
--data "invoices[]=2" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"invoiceid": 12345
}

Примеры ошибок

``` { "code": -1, "message": "$module/mass_pay: failed to created masspay invoice - error_details" }

```

whmcs/request_cancellation¶

Инициирует процесс автоматической или ручной отмены услуги в WHMCS с расчетом возврата средств, учетом трафика и налогов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_cancellation`
id	✅	int	ID сервера (eq server id)
cancellation_type	❌	int	Тип отмены (1 - автоматическая/с возвратом)
cancellation_reason	❌	string	Причина отмены
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=request_cancellation" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "request_cancellation",
"data": {
"account_id": 12345,
"amount": 0.0,
"billing": "WHMCS",
"cancellation_reason": "User requested cancellation",
"cancellation_type": 1,
"clientid": 9876,
"created": "2024-05-20T12:00:00Z",
"currency": "USD",
"customfields": {},
"dc_location": "DataCenter",
"description": "Service description",
"displayid": 123,
"email": "user@example.com",
"hwconfig": {},
"invoiceid": 555666
}
}

Примеры ошибок

``` { "code": -1, "message": "Invoice include several servers. Please contact support" }

```

whmcs/request_subscription_cancellation¶

Инициирует процесс отмены подписки через создание тикета в JIRA и уведомление биллинга. Проверяет статус подписки в WHMCS и наличие открытых тикетов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `request_subscription_cancellation`
id	✅	int	ID сервера (eq server id)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=request_subscription_cancellation" \
--data "id=VALUE" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"ticket": "JIRA-12345"
}

Примеры ошибок

``` { "code": -1, "message": "sub_cancel_not_allowed_billing" }

```

whmcs/reset_password¶

Инициирует процесс сброса пароля: отправляет ссылку на email или запрашивает 2FA код для подтверждения личности.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `reset_password`
email	✅	string	Email пользователя для отправки ссылки на сброс пароля или проверки 2FA
location	❌	string	Локация (по умолчанию 'Auto')
reset_token	❌	string	Хеш-токен для верификации сброса пароля через SHA256
pass	❌	string	Новый пароль (передается в POST или GET)
code	❌	string	Код двухфакторной аутентификации (2FA)

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=reset_password" \
--data "email=user@example.com"

Пример успешного ответа

{
"result": "OK",
"message": "Password reset link was sent to the registred email."
}

Примеры ошибок

``` { "code": -1, "message": "Invalid password reset token, please try again." }

```

whmcs/transactions¶

Возвращает список транзакций пользователя на основе предоставленного ID транзакции или инвойса

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `transactions`
transaction_id	❌	string	ID транзакции для фильтрации
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=transactions" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"transactions": [
{
"id": 12345,
"amount": 50.0,
"status": "Completed",
"date": "2024-01-15T10:30:00Z"
}
]
}

Примеры ошибок

``` { "code": -1, "message": "$module/transactions: failed to retrive transactions - error_details" }

```

whmcs/update_client¶

Обновляет профиль клиента в WHMCS, включая персональные данные, контактную информацию, настройки 2FA и кастомные поля. Поддерживает проверку типов (компания/физлицо) и валидацию данных.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_client`
params[billing_email]	❌	string	Электронная почта клиента (проверяется на уникальность и формат)
params[billing_firstname]	❌	string	Имя клиента
params[billing_lastname]	❌	string	Фамилия клиента
params[billing_phonenumber]	❌	string	Номер телефона (автоматически очищается от спецсимволов)
params[co_smsnum]	❌	string	SMS номер для верификации
params[tg_username]	❌	string	Username в Telegram (формат @username)
params[co_secret]	❌	string	Секретное слово профиля
params[ips]	❌	string	Список IP-адресов для ACL (через пробел)
params[billing_address1]	❌	string	Адрес проживания/регистрации
params[billing_city]	❌	string	Город
params[billing_postcode]	❌	string	Почтовый индекс
params[billing_country]	❌	string	Код страны (например, RU, US)
params[co_customertype]	❌	string	Тип клиента (Individual / Company)
params[billing_twofaenabled]	❌	boolean	Статус включения двухфакторной аутентификации
params[co_inn]	❌	string	ИНН (для юридических лиц)
params[co_kpp]	❌	string	КПП (для юридических лиц)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=update_client" \
--data "token=HOSTKEY_TOKEN" \
--data "params[billing_email]=user@example.com" \
--data "params[billing_firstname]=John" \
--data "params[billing_lastname]=Doe"

Пример успешного ответа

{
"result": "OK",
"action": "update_client",
"data": {
"billing_email": "user@example.com",
"billing_firstname": "John",
"billing_lastname": "Doe",
"co_smsnum": "+79001234567",
"twofaenabled": 1,
"customfields": "base64_encoded_serialized_data"
}
}

Примеры ошибок

``` { "code": -1, "message": "Account type change is not allowed" }

```

whmcs/update_contact¶

Обновляет информацию о контакте (имя, фамилия, email, телефон) в WHMCS. Поддерживает проверку пароля и валидацию полей в зависимости от локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_contact`
params[contact_id]	✅	int	ID контакта для обновления
params[email]	✅	string	Email пользователя (обязателен)
params[firstname]	❌	string	Имя контакта
params[lastname]	❌	string	Фамилия контакта
params[phonenumber]	❌	string	Номер телефона (проходит валидацию и трансляцию)
params[password1]	❌	string	Текущий пароль для проверки
params[password2]	❌	string	Новый пароль (если указан password1)
token	✅	string	API-токен аутентификации

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs.php" -X POST \
--data "action=update_contact" \
--data "params[contact_id]=12345" \
--data "params[email]=user@example.com" \
--data "token=YOUR_API_TOKEN"

Пример успешного ответа

{
"result": "success",
"clientid": 12345,
"email": "user@example.com",
"firstname": "John",
"lastname": "Doe",
"phonenumber": "+79001234567",
"status": "active"
}

Примеры ошибок

``` { "code": -1, "message": "fill_required_fields" }

```