whmcs.php¶
Модуль интеграции с WHMCS для управления клиентами, счетами, кредитом, отменами заказов и биллинговыми данными серверов.
Методы API¶
| Метод | Действие | Описание |
|---|---|---|
add_contact | создание контакта | Добавляет новый контакт к существующему клиенту в биллинге. |
apply_credit | применение кредита | Применяет кредит с баланса клиента к оплате указанного счета. |
create_addfunds | создание счета пополнения | Создает счет для пополнения баланса (Add Funds). |
delete_cancellation_request | удаление запроса на отмену | Удаляет активный запрос на отмену сервера и восстанавливает счет. |
delete_contact | удаление контакта | Удаляет контакт из аккаунта клиента. |
download_invoice | скачивание счета | Генерирует и возвращает PDF файл счета. |
generate_due_invoice | генерация счета | Генерирует следующий счет для оплаты сервера. |
get_billing_data | получение биллинговых данных | Получает синхронизированные данные биллинга для сервера. |
get_cancellation_requests | получение запросов на отмену | Возвращает список активных запросов на отмену серверов. |
get_client | получение данных клиента | Возвращает информацию об авторизованном клиенте или по ID. |
get_clientgroups | получение групп клиентов | Возвращает список групп клиентов в биллинге. |
get_contacts | получение контактов | Возвращает список дополнительных контактов клиента. |
get_invoice | получение счета | Возвращает данные конкретного счета. |
get_invoices | получение счетов | Возвращает список счетов клиента. |
get_related_invoices | получение связанных счетов | Возвращает счета, связанные с сервером или аккаунтом. |
getcredits | получение кредитов | Возвращает историю кредитов клиента. |
getpaymentgw | получение шлюзов оплаты | Возвращает доступные методы оплаты для счета. |
mass_pay | массовая оплата | Оплачивает несколько счетов одним платежом. |
request_cancellation | запрос на отмену | Инициирует процесс отмены сервера с расчетом возврата средств. |
reset_password | сброс пароля | Инициирует сброс пароля или устанавливает новый с 2FA. |
transactions | получение транзакций | Возвращает историю транзакций клиента. |
update_client | обновление клиента | Обновляет данные профиля клиента в биллинге. |
update_contact | обновление контакта | Обновляет данные контакта клиента. |
whmcs/add_contact¶
Добавляет новый контакт к существующему клиенту в биллинге.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: add_contact |
| token | ✅ | string | Токен авторизации |
| profile_data[email] | ✅ | string | Email нового контакта |
| profile_data[password2] | ✅ | string | Пароль для нового контакта |
| profile_data[firstname] | ❌ | string | Имя контакта |
| profile_data[lastname] | ❌ | string | Фамилия контакта |
| profile_data[phonenumber] | ❌ | string | Номер телефона в формате E164 |
| profile_data[companyname] | ❌ | string | Название компании |
| profile_data[address1] | ❌ | string | Адрес строка 1 |
| profile_data[address2] | ❌ | string | Адрес строка 2 |
| profile_data[city] | ❌ | string | Город |
| profile_data[state] | ❌ | string | Штат/Область |
| profile_data[postcode] | ❌ | string | Почтовый индекс |
| profile_data[country] | ❌ | string | Страна |
| profile_data[tax_id] | ❌ | string | Идентификатор налогоплательщика |
| profile_data[permissions] | ❌ | string | Права доступа контакта |
| profile_data[generalemails] | ❌ | string | Получать общие письма |
| profile_data[domainemails] | ❌ | string | Получать письма о доменах |
| profile_data[invoiceemails] | ❌ | string | Получать письма о счетах |
| profile_data[productemails] | ❌ | string | Получать письма о продуктах |
| profile_data[supportemails] | ❌ | string | Получать письма поддержки |
| profile_data[affiliateemails] | ❌ | string | Получать письма о партнерской программе |
| profile_data[subaccount] | ❌ | string | Создать подучетную запись |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=add_contact" \
--data "token=HOSTKEY_TOKEN" \
--data "profile_data[email]=user@example.com" \
--data "profile_data[password2]=SecurePassword123" \
--data "profile_data[firstname]=John" \
--data "profile_data[lastname]=Doe"
Пример успешного ответа
Примеры ошибок
whmcs/apply_credit¶
Применяет кредит с баланса клиента к оплате указанного счета.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: apply_credit |
| token | ✅ | string | Токен авторизации |
| invoice_id | ✅ | int | ID счета для оплаты |
| amount | ✅ | float | Сумма кредита для применения |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=apply_credit" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=VALUE" \
--data "amount=VALUE"
Пример успешного ответа
Примеры ошибок
whmcs/create_addfunds¶
Создает счет для пополнения баланса (Add Funds).
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: create_addfunds |
| token | ✅ | string | Токен авторизации |
| amount | ✅ | float | Сумма пополнения |
| description | ❌ | string | Описание транзакции |
| subscribe | ❌ | int | Флаг для настройки автоплатежа |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=create_addfunds" \
--data "token=HOSTKEY_TOKEN" \
--data "amount=VALUE" \
--data "description=Optional description" \
--data "subscribe=1"
Пример успешного ответа
Примеры ошибок
whmcs/delete_cancellation_request¶
Удаляет активный запрос на отмену сервера и восстанавливает счет.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: delete_cancellation_request |
| token | ✅ | string | Токен авторизации |
| id | ✅ | int | ID сервера |
| full | ❌ | int | Возвращать полные данные |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=delete_cancellation_request" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"action": "delete_cancellation_request",
"message": "Cancellation request removed"
}
Примеры ошибок
whmcs/delete_contact¶
Удаляет контакт из аккаунта клиента.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: delete_contact |
| token | ✅ | string | Токен авторизации |
| contact_id | ✅ | int | ID контакта для удаления |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=delete_contact" \
--data "token=HOSTKEY_TOKEN" \
--data "contact_id=VALUE"
Пример успешного ответа
Примеры ошибок
whmcs/download_invoice¶
Генерирует и возвращает PDF файл счета.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: download_invoice |
| token | ✅ | string | Токен авторизации |
| invoice_id | ✅ | int | ID счета |
| proforma_invoice | ❌ | int | Флаг проформы (0 или 1) |
| viewpdf | ❌ | int | Отображать в браузере (1) или скачать (0) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=download_invoice" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=VALUE"
Пример успешного ответа
{
"result": "OK",
"action": "download_invoice",
"content_type": "application/pdf",
"message": "PDF binary data"
}
Примеры ошибок
whmcs/generate_due_invoice¶
Генерирует следующий счет для оплаты сервера.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: generate_due_invoice |
| token | ✅ | string | Токен авторизации |
| id | ✅ | int | ID сервера |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=generate_due_invoice" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"action": "generate_due_invoice",
"invoices": [
{
"id": 12345,
"status": "Unpaid",
"total": 50.0
}
]
}
Примеры ошибок
whmcs/get_billing_data¶
Получает синхронизированные данные биллинга для сервера.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_billing_data |
| token | ✅ | string | Токен авторизации |
| id | ✅ | int | ID сервера |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_billing_data" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа
{
"result": "OK",
"Condition_Component": "rent",
"account_id": 500,
"billing_cycle": "monthly",
"billing_reccuring": 49.99,
"billing_status": "Active",
"currencysuffix": "EUR",
"customer_email": "user@example.com",
"customer_name": "John Doe",
"days": 30,
"days_left": 15,
"groupdata": {
"discountpercent": 0
},
"invert": 0,
"lock_billing_cycle_change": 0,
"name_client": "John Doe",
"next_due_date": "2024-02-15"
}
Примеры ошибок
whmcs/get_cancellation_requests¶
Возвращает список активных запросов на отмену серверов.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_cancellation_requests |
| token | ✅ | string | Токен авторизации |
| id | ❌ | int | ID сервера (опционально). Если не указан, возвращается список для текущего пользователя |
| period_from | ❌ | string | Начало периода фильтрации (YYYY-MM-DD) |
| period_to | ❌ | string | Конец периода фильтрации (YYYY-MM-DD) |
| cancellation_type | ❌ | string | Тип отмены (фильтр) |
| billing_status | ❌ | string | Статус биллинга (фильтр) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_cancellation_requests" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "success",
"message": [
{
"id": 101,
"relid": 500,
"date": "2024-01-20",
"reason": "Too expensive",
"type": "Immediate",
"billing_status": "Active",
"due_date": "2024-02-20",
"name_client": "John Doe",
"corporate": "N",
"customer_id": 12345
}
]
}
Примеры ошибок
whmcs/get_client¶
Возвращает информацию об авторизованном клиенте или по ID.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_client |
| token | ✅ | string | Токен авторизации |
| client_id | ❌ | int | ID клиента (используется если email не передан) |
| ❌ | string | Email клиента (используется если client_id не передан) | |
| full | ❌ | bool | Возвращать полные данные (включая пароли) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_client" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "OK",
"client": {
"id": 123,
"firstname": "John",
"lastname": "Doe",
"email": "john@example.com",
"companyname": "Acme Corp",
"status": "Active",
"credit": 100.5,
"currency_code": "EUR",
"corporate": 0,
"inn": "",
"contractnum": "",
"twofa_method": "none",
"twofaenabled": false,
"customfields": []
},
"billing_location": "whmcs",
"internal": {
"id": 456,
"verified": true,
"firstname": "John",
"lastname": "Doe"
},
"groupdata": {
"id": 1,
"groupname": "Reseller"
}
}
Примеры ошибок
whmcs/get_clientgroups¶
Возвращает список групп клиентов в биллинге.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_clientgroups |
| token | ✅ | string | Токен авторизации |
| location | ❌ | string | Локация биллинга (например, whmcs, whmcs_ru) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_clientgroups" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "success",
"groups": {
"group": [
{
"id": "1",
"groupname": "Resellers",
"discount": "10"
}
]
}
}
Примеры ошибок
whmcs/get_contacts¶
Возвращает список дополнительных контактов клиента.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_contacts |
| token | ✅ | string | Токен авторизации |
| full | ❌ | boolean | Возвращать полные данные (включая все поля WHMCS) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_contacts" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "OK",
"action": "get_contacts",
"permission_contacts_granted": true,
"contacts": [
{
"id": "101",
"firstname": "Jane",
"lastname": "Smith",
"email": "jane@example.com",
"permissions": "invoices,contacts"
}
]
}
Примеры ошибок
whmcs/get_invoice¶
Возвращает данные конкретного счета.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_invoice |
| token | ✅ | string | Токен авторизации |
| invoice_id | ✅ | int | ID счета |
| load_client_data | ❌ | int | Загружать данные клиента (1 - да, 0 - нет) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_invoice" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=VALUE"
Пример успешного ответа
{
"result": "OK",
"invoiceid": 5001,
"date": "2024-01-01",
"duedate": "2024-01-31",
"total": 50.0,
"status": "Unpaid",
"currencycode": "USD",
"billing": "whmcs",
"items": {
"item": [
{
"description": "VPS Server",
"amount": 50.0,
"relid": 12345,
"inv_id": 12345
}
]
},
"customer": {
"client": {
"firstname": "John",
"lastname": "Doe",
"currency_code": "USD"
}
},
"firstname": "John",
"lastname": "Doe"
}
Примеры ошибок
whmcs/get_invoices¶
Возвращает список счетов клиента.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_invoices |
| token | ✅ | string | Токен авторизации |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_invoices" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "OK",
"totalresults": 5,
"numreturned": 5,
"invoices": {
"invoice": [
{
"id": 5001,
"invoicenumber": "1001",
"date": "2024-01-01",
"duedate": "2024-01-15",
"total": 50.0,
"status": "Unpaid",
"items": {
"item": [
{
"type": "Hosting",
"description": "VPS Server",
"amount": 50.0
}
]
}
}
]
}
}
Примеры ошибок
whmcs/get_related_invoices¶
Возвращает счета, связанные с сервером или аккаунтом.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_related_invoices |
| token | ✅ | string | Токен авторизации |
| id | ❌ | int | ID сервера (eq_id). Если передан, используется для поиска account_id. |
| account_id | ❌ | int | ID аккаунта в биллинге (product_id). Используется напрямую для поиска счетов. |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=get_related_invoices" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"
Пример успешного ответа
{
"result": "success",
"invoices": [
{
"id": 5001,
"invoiceid": "INV-5001",
"date": "2023-10-25",
"duedate": "2023-11-01",
"total": 50.0,
"status": "Unpaid",
"userid": 12345
}
]
}
Примеры ошибок
whmcs/getcredits¶
Возвращает историю кредитов клиента.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: getcredits |
| token | ✅ | string | Токен авторизации |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=getcredits" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "OK",
"action": "getcredits",
"message": {
"credits": [
{
"id": 1,
"date": "2024-01-01",
"amount": 100.0,
"description": "Add Funds"
}
]
}
}
Примеры ошибок
{
"code": -1,
"message": "failed to retrive account history at whmcs, please contact support - unknown error"
}
whmcs/getpaymentgw¶
Возвращает доступные методы оплаты для счета.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: getpaymentgw |
| token | ✅ | string | Токен авторизации |
| invoice_id | ✅ | int | ID счета для получения шлюзов оплаты |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=getpaymentgw" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=VALUE"
Пример успешного ответа
{
"result": "OK",
"methods": {
"creditcard": {
"name": "Credit Card",
"call": "https://billing.example.com/pay.php?id=123"
},
"yookassa": {
"name": "YooKassa",
"call": "https://yookassa.example.com/checkout"
}
}
}
Примеры ошибок
whmcs/mass_pay¶
Оплачивает несколько счетов одним платежом.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: mass_pay |
| token | ✅ | string | Токен авторизации |
| invoices | ✅ | array<int> | Массив ID счетов для оплаты |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=mass_pay" \
--data "token=HOSTKEY_TOKEN" \
--data "invoices[]=123" \
--data "invoices[]=456"
Пример успешного ответа
Примеры ошибок
whmcs/request_cancellation¶
Инициирует процесс отмены сервера с расчетом возврата средств.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: request_cancellation |
| token | ✅ | string | Токен авторизации |
| id | ✅ | int | ID сервера |
| cancellation_type | ✅ | int | Тип отмены (1 - немедленная) |
| cancellation_reason | ❌ | string | Причина отмены |
| terminate_reason_custom | ❌ | string | Пользовательская причина |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=request_cancellation" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "cancellation_type=VALUE"
Пример успешного ответа
Примеры ошибок
whmcs/reset_password¶
Инициирует сброс пароля или устанавливает новый с 2FA.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: reset_password |
| ✅ | string | Email клиента | |
| reset_token | ❌ | string | Токен сброса пароля |
| pass | ❌ | string | Новый пароль |
| code | ❌ | string | Код 2FA |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=reset_password" \
--data "email=VALUE"
Пример успешного ответа
Примеры ошибок
whmcs/transactions¶
Возвращает историю транзакций клиента.
HTTP-метод: GET
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: transactions |
| token | ✅ | string | Токен авторизации |
| invoice_id | ❌ | int | Фильтр по ID счета |
| transaction_id | ❌ | string | Фильтр по ID транзакции |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X GET \
--data "action=transactions" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа
{
"result": "OK",
"transactions": [
{
"id": 123,
"date": "2024-01-01",
"amount": 50.0,
"status": "Complete"
}
]
}
Примеры ошибок
whmcs/update_client¶
Обновляет данные профиля клиента в биллинге.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: update_client |
| token | ✅ | string | Токен авторизации |
| profile_data[billing_firstname] | ❌ | string | Имя клиента |
| profile_data[billing_lastname] | ❌ | string | Фамилия клиента |
| profile_data[billing_email] | ❌ | string | Email клиента |
| profile_data[billing_phonenumber] | ❌ | string | Телефон клиента |
| profile_data[co_smsnum] | ❌ | string | Номер для SMS |
| profile_data[ips] | ❌ | string | Список IP для ACL |
| profile_data[billing_companyname] | ❌ | string | Название компании |
| profile_data[billing_address1] | ❌ | string | Адрес строка 1 |
| profile_data[billing_address2] | ❌ | string | Адрес строка 2 |
| profile_data[billing_city] | ❌ | string | Город |
| profile_data[billing_postcode] | ❌ | string | Индекс |
| profile_data[billing_country] | ❌ | string | Страна |
| profile_data[billing_state] | ❌ | string | Штат/Область |
| profile_data[co_inn] | ❌ | string | ИНН (для юр. лиц) |
| profile_data[co_kpp] | ❌ | string | КПП (для юр. лиц) |
| profile_data[co_regaddress] | ❌ | string | Юридический адрес |
| profile_data[co_bankdata] | ❌ | string | Банковские реквизиты |
| profile_data[co_edo] | ❌ | string | ЭДО статус |
| profile_data[co_edoprovider] | ❌ | string | Провайдер ЭДО |
| profile_data[co_contractid] | ❌ | string | Номер договора |
| profile_data[co_contract] | ❌ | string | Данные договора |
| profile_data[co_customertype] | ❌ | string | Тип клиента (Individual/Company) |
| profile_data[co_subscription] | ❌ | string | ID подписки |
| profile_data[co_web] | ❌ | string | Сайт компании |
| profile_data[co_size] | ❌ | string | Размер компании |
| profile_data[co_industry] | ❌ | string | Отрасль |
| profile_data[co_autopayment] | ❌ | string | Автоплатеж |
| profile_data[co_payfirstday] | ❌ | string | Оплата первого дня |
| profile_data[co_marktemails] | ❌ | string | Маркетинговые письма |
| profile_data[co_marktsms] | ❌ | string | Маркетинговые SMS |
| profile_data[co_passdata] | ❌ | string | Данные паспорта |
| profile_data[co_skype] | ❌ | string | Skype |
| profile_data[co_origin] | ❌ | string | Источник |
| profile_data[co_secret] | ❌ | string | Секретное слово |
| profile_data[co_comment] | ❌ | string | Комментарий |
| profile_data[billing_status] | ❌ | string | Статус клиента |
| profile_data[billing_emailoptout] | ❌ | boolean | Отписка от писем |
| profile_data[billing_marketingoptin] | ❌ | boolean | Подписка на маркетинг |
| profile_data[billing_overideduenotices] | ❌ | boolean | Игнорировать уведомления о просрочке |
| profile_data[billing_separateinvoices] | ❌ | boolean | Раздельные счета |
| profile_data[billing_taxexempt] | ❌ | boolean | Освобождение от налогов |
| profile_data[billing_latefeeoveride] | ❌ | boolean | Игнорировать пени |
| profile_data[billing_overrideautoclose] | ❌ | boolean | Игнорировать автозакрытие |
| profile_data[billing_allowSingleSignOn] | ❌ | boolean | Разрешить SSO |
| profile_data[billing_disableautocc] | ❌ | boolean | Отключить автооплату картой |
| profile_data[billing_groupid] | ❌ | integer | ID группы клиентов |
| profile_data[billing_currency] | ❌ | string | Валюта |
| profile_data[billing_notes] | ❌ | string | Примечания |
| profile_data[billing_twofaenabled] | ❌ | boolean | Включить 2FA |
| profile_data[co_2famethod] | ❌ | string | Метод 2FA |
| profile_data[tag_autocreditenabled] | ❌ | boolean | Включить автокредит |
| profile_data[tg_username] | ❌ | string | Telegram username |
| profile_data[form_id] | ❌ | string | ID формы (personal_data, account_owner, address) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=update_client" \
--data "token=HOSTKEY_TOKEN" \
--data "profile_data[billing_firstname]=John" \
--data "profile_data[billing_lastname]=Doe"
Пример успешного ответа
{
"result": "success",
"message": "Client updated successfully",
"clientid": 12345,
"billing_email": "client@example.com",
"billing_email_changed": false,
"billing_email_illegal_change_attempt": false,
"edit_master_profile": false,
"close_window": false
}
Примеры ошибок
whmcs/update_contact¶
Обновляет данные контакта клиента.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: update_contact |
| token | ✅ | string | Токен авторизации |
| profile_data[contact_id] | ✅ | int | ID контакта |
| profile_data[email] | ✅ | string | Email контакта |
| profile_data[password2] | ❌ | string | Новый пароль |
| profile_data[phonenumber] | ❌ | string | Телефон контакта (E164) |
| profile_data[firstname] | ❌ | string | Имя контакта |
| profile_data[lastname] | ❌ | string | Фамилия контакта |
| profile_data[permissions] | ❌ | string | Права доступа (список через запятую) |
Пример запроса
curl -s "https://invapi.hostkey.ru/whmcs" -X POST \
--data "action=update_contact" \
--data "token=HOSTKEY_TOKEN" \
--data "profile_data[contact_id]=VALUE" \
--data "profile_data[email]=VALUE"