whmcs_hooks¶

В этой статье

Методы API

whmcs_hooks/ClientAdd

whmcs_hooks/InvoiceCreation

whmcs_hooks/client_payment

whmcs_hooks/invoice_total_updated

whmcs_hooks/whmcs_invoice_created

whmcs_hooks/whmcs_invoice_paid

whmcs_hooks/whmcs_invoice_reminder

(описание будет добавлено при генерации)

Методы API¶

| Метод | Действие | Описание | |-------|----------|----------|| ClientAdd | регистрация нового клиента | Обрабатывает создание нового клиента в WHMCS, отправляет приветственное письмо и автоматически переводит клиента в тестовую группу при использовании Hostkey email. || client_payment | обработка платежа | Обрабатывает callback от платежной системы. Проверяет токен безопасности и выполняет финансовые операции через PaymentCallbackHandler. || whmcs_invoice_created | создание счета | Вызывается при создании нового счета в WHMCS. Инициирует процесс создания заказа и уведомляет клиента. || invoice_total_updated | обновление суммы счета | Вызывается при изменении итоговой суммы счета. Выполняет пересчет кредитов (rebalance) в системе. || whmcs_invoice_reminder | напоминание об оплате | Вызывается при отправке напоминаний о неоплаченном счете. Инициирует уведомление клиента. || InvoiceCreation | создание инвойса | Вызывается при создании нового инвойса в WHMCS для инициализации связанных процессов. || whmcs_invoice_paid | оплата инвойса | Обработка события оплаты инвойса: проверка заказа, очистка перерасхода трафика и уведомление клиента. |

whmcs_hooks/ClientAdd¶

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

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `ClientAdd`
email	❌	string	Электронная почта клиента для проверки на принадлежность к Hostkey.
userid	❌	integer	Идентификатор пользователя в системе WHMCS.
location	❌	string	Локация (billing location) для определения групп клиентов.

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=ClientAdd"

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

{
"result": "OK",
"action": "ClientAdd operations completed: [status]",
"data": {
"error": "No client data provided"
}
}

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

{
"code": -1,
"message": "No client data provided"
}

whmcs_hooks/InvoiceCreation¶

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

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `InvoiceCreation`
invoice_id	✅	integer	Уникальный идентификатор инвойса в системе WHMCS.
location	✅	string	Локация или серверная площадка для обработки операции.
invoiceid	❌	integer	Уникальный идентификатор счета в системе.
invoiceId	❌	integer	Уникальный идентификатор счета в системе.

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=InvoiceCreation" \
--data "invoice_id=12345" \
--data "location=DC-1"

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

{
"result": "OK",
"action": "InvoiceCreation",
"data": {
"status": "processed"
}
}

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

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

whmcs_hooks/client_payment¶

Обрабатывает callback от платежной системы. Проверяет токен безопасности и выполняет финансовые операции через PaymentCallbackHandler.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `client_payment`
location	❌	string	Местоположение или контекст обработки платежа.
payment_id	❌	integer	Идентификатор платежной транзакции.
client_id	❌	integer	Идентификатор клиента в системе WHMCS.

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=client_payment" \
--data "location=webshop" \
--data "payment_id=12345" \
--data "client_id=67890"

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

{
"result": "OK",
"action": "payment [id]: [status]",
"data": {}
}

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

{
"code": -1,
"message": "Unauthorized"
}

whmcs_hooks/invoice_total_updated¶

Вызывается при изменении итоговой суммы счета. Выполняет пересчет кредитов (rebalance) в системе.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `invoice_total_updated`
invoice_id	✅	integer	Уникальный идентификатор счета для пересчета кредитов
location	✅	string	Местоположение биллинга (billing location)
invoiceid	❌	integer	Уникальный идентификатор счета в системе.
invoiceId	❌	string	Идентификатор счета (переданный как строка).

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=invoice_total_updated" \
--data "invoice_id=123" \
--data "location=DC-1"

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

{
"result": "success",
"excess_returned": 1.5,
"invoice_gross": 10.5,
"transid": "rebalance-123-1678901234"
}

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

{
"code": -1,
"message": "invoice_total_updated: missing invoice_id"
}

whmcs_hooks/whmcs_invoice_created¶

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

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `whmcs_invoice_created`
location	✅	string	Локация (billing location) для обработки счета и уведомления клиента.
invoiceid	❌	integer	Уникальный идентификатор созданного счета.
invoiceId	❌	integer	Уникальный идентификатор созданного счета.
userid	❌	integer	Идентификатор пользователя в системе.
userId	❌	integer	Идентификатор пользователя в системе.
serviceid	❌	integer	Идентификатор связанного сервиса или услуги.
status	❌	string	Текущий статус счета.
domainstatus	❌	string	Статус доменного имени, связанного со счетом.

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=whmcs_invoice_created" \
--data "location=VALUE"

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

{
"result": "OK",
"action": "whmcs_invoice_created operations completed: invoice [id] creation proceeded: [result]",
"data": {}
}

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

{
"code": -1,
"message": "Invalid billing location"
}

whmcs_hooks/whmcs_invoice_paid¶

Обработка события оплаты инвойса: проверка заказа, очистка перерасхода трафика и уведомление клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: whmcs_invoice_paid
invoice_id	✅	integer	Уникальный идентификатор инвойса в системе WHMCS
location	✅	string	Локация биллинга (например, RU)
order_id	❌	integer	Идентификатор заказа в системе
invoiceid	❌	integer	Идентификатор счета в системе WHMCS.
invoiceId	❌	integer	Идентификатор счета в системе WHMCS.
orderId	❌	integer	Уникальный номер заказа клиента.
userid	❌	integer	Идентификатор пользователя в системе WHMCS.
userId	❌	integer	Уникальный идентификатор клиента.
serviceid	❌	integer	Идентификатор услуги в системе WHMCS.
status	❌	string	Текущий статус оплаты счета.
domainstatus	❌	string	Статус доменного имени клиента.

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=whmcs_invoice_paid" \
--data "invoice_id=12345" \
--data "location=RU"

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

{
"result": "OK",
"action": "whmcs_invoice_paid",
"data": {
"status": "Paid",
"items": [
{
"id": 101,
"name": "Service Item",
"price": {
"USD": 50.0,
"EUR": 46.5
}
}
]
}
}

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

{
"code": -1,
"message": "Ошибка обработки оплаты инвойса",
"details": {
"invoice_id": 12345
}
}

whmcs_hooks/whmcs_invoice_reminder¶

Вызывается при отправке напоминаний о неоплаченном счете. Инициирует уведомление клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `whmcs_invoice_reminder`
invoice_id	✅	integer	Уникальный идентификатор счета для отправки напоминания
status	❌	string	Текущий статус счета
location	❌	string	Локация клиента для определения языка уведомления
invoiceid	❌	integer	Уникальный идентификатор счета в системе.
invoiceId	❌	integer	Уникальный идентификатор счета в системе.
userid	❌	integer	Идентификатор пользователя, связанного со счетом.
userId	❌	integer	Идентификатор пользователя, связанного со счетом.
serviceid	❌	integer	Идентификатор услуги, к которой привязан счет.
domainstatus	❌	string	Текущий статус домена или связанного сервиса.

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

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=whmcs_invoice_reminder" \
--data "invoice_id=12345"

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

{
"result": "OK",
"action": "whmcs_invoice_reminder operations completed: invoice [id] reminders proceeded",
"data": {}
}

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

{
"code": -1,
"message": "Error during reminder processing"
}