Документация API (интерфейс прикладного программирования) панели управления Invapi¶
В этой документации описан общий дизайн и принципы работы API, а также конкретные конечные точки. Также приведены примеры запросов к ним.
Информация
Панель управления invapi.hostkey.ru построена на основе этого API.
Запросы API¶
Запросы должны выполняться по протоколу HTTPS, чтобы гарантировать шифрование транзакций.
Для запросов необходимо использовать метод POST, если не указано иное.
Формат примеров API¶
Примеры в этой документации описаны с помощью сurl, HTTP-клиента командной строки. На компьютерах Linux и macOS обычно по умолчанию установлен curl, и он доступен для загрузки на всех популярных платформах, включая Windows.
Каждый пример разделен на несколько строк символом \, который совместим с bash. Типичный пример выглядит так:
Пример запроса POST:
Параметр -X задает метод запроса. Для согласованности метод будет указан во всех примерах, даже если он явно не требуется для методов GET.
Примеры, для которых требуется объект JSON в теле запроса, передают требуемые данные через параметр --data.
Ответ на запросы происходит в формате JSON и в документации отформатирован для удобочитаемости.
Примечание
Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на Linux это можно сделать с помощью команды:
После этого токен будет автоматически подставляться в ваши запросы.
Примечание
Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на идентификаторы операционных систем, тарифов и т.д., используемые в примерах. Используйте ваши значения серверов/сетей/доменов для получения значений или перед созданием ресурсов. В некоторых случаях будет работать только API ключ аккаунта, а не конкретного сервера (и наоборот), поэтому при ошибках авторизации метода попробуйте переключить тип API-ключа.
api_keys.php¶
Модуль управления API-ключами: создание, редактирование, удаление, просмотр истории и получение списков ключей для клиентов и серверов.
| Метод | Описание |
|---|---|
add | Создает новый API ключ для клиента или конкретного сервера. Требуется наличие активных серверов у клиента. |
delete | Удаляет указанный API ключ из системы. |
edit | Изменяет параметры существующего API ключа (название, IP, статус, срок действия). |
history | Возвращает историю действий с API ключами (создание, изменение, удаление). |
list | Возвращает список всех API ключей текущего клиента. |
list_for_server | Возвращает список API ключей, привязанных к конкретному серверу. |
view | Возвращает детальную информацию об одном API ключе. |
auth.php¶
Модуль аутентификации и авторизации: управление сессиями, вход через WHMCS, LDAP, API-ключи и SSO (Google, GitHub, VK), верификация 2FA, SMS и email, а также управление тегами клиентов.
| Метод | Описание |
|---|---|
2fa_check | Валидирует код двухфакторной аутентификации для текущей сессии пользователя. |
2fa_resend | Отправляет повторный код двухфакторной аутентификации на указанный метод (Email или SMS) для текущей сессии. |
billing_list | Возвращает список доступных платежных систем (биллингов), настроенных для текущего пользователя или администратора. |
email_check | Проверяет существование клиента по email в указанной локации биллинга. Если клиент не найден, создается новый профиль. Отправляет код верификации на почту. |
flip_tag | Создает или удаляет указанный тег у клиента. Если тег уже существует, он будет удален; если не существует — добавлен. |
get_log | Возвращает лог событий авторизации за указанный период или по токену. |
get_log_details | Возвращает подробную информацию о событиях аутентификации для пользователя по его токену. |
github_init | Инициирует процесс авторизации через GitHub, генерирует уникальный state и возвращает данные клиента для перенаправления пользователя на GitHub. |
github_signin | Инициирует процесс OAuth авторизации через GitHub. Генерирует временный state и токен для последующего обмена кода на сессию. |
google_signin | Выполняет вход в систему с использованием Google ID Token. Если токен валиден, привязывает его к текущей сессии или связывает с существующим аккаунтом пользователя. |
info | Возвращает подробную информацию о текущей сессии пользователя, включая роль, права доступа (permissions), данные клиента и список доступных серверов. |
login | Авторизует пользователя через предоставленный API-ключ, устанавливает сессию и возвращает данные о правах доступа и доступных серверах. |
logout | Удаляет текущий активный токен доступа, завершая сессию пользователя. |
session_reset | Завершает все активные сессии пользователя, основываясь на его email и токене сброса. Выполняет очистку тегов (сессий) в базе данных. |
set_tag | Создает или удаляет тег у клиента. Для обычных пользователей разрешено использование только тега 'auto_credit'. |
tg_verify | Привязывает Telegram username пользователя к его аккаунту и возвращает ссылку на бота для уведомлений. |
vk_init | Инициирует процесс OAuth-авторизации через VK, генерируя временные данные (state, code_challenge) и сохраняя их в базе данных для последующей проверки. |
vk_signin | Инициирует процесс авторизации пользователя через социальную сеть ВКонтакте. Создает временные теги для завершения OAuth-процесса и перенаправляет на страницу подтверждения. |
whmcslogin | Выполняет вход в систему. Поддерживает стандартную авторизацию по email/паролю, а также вход через сторонние сервисы (Google, GitHub, VK) и автоматический выбор биллинга. |
eq.php¶
Модуль управления оборудованием (eq.php): API для развертывания серверов, управления питанием, IPMI, резервными копиями, поиска и получения детальной информации о конфигурации оборудования.
| Метод | Описание |
|---|---|
abort_reinstall | Прекращает процесс переустановки сервера, удаляет связанные теги (reinstall_start, autodeploy_start, autodeploy_timeout) и восстанавливает настройки VLAN. |
add_ipmi_admin | Создает нового пользователя с правами администратора для управления через IPMI. Если пользователь уже существует, возвращает его данные. |
add_ipmi_user | Добавляет нового пользователя в систему управления IPMI для конкретного сервера. Если пользователь является администратором, параметры могут быть переопределены. |
announceip | Выполняет анонс указанной подсети или конкретного IP-адреса для сервера. |
backup_get_schedule | Возвращает текущее расписание автоматических бэкапов для указанного сервера |
backup_list | Возвращает список доступных резервных копий для указанного оборудования (сервера) |
backup_save_schedule | Сохраняет настроенное расписание резервного копирования для указанного сервера |
boot_dev | Запрашивает переключение режима загрузки сервера (PXE или диск) для использования загрузочного носителя. |
check_backup_lock | Проверяет наличие активной блокировки на выполнение операций с бэкапом для указанного сервера. |
check_pin | Проверяет PIN-код для операций. |
clear_pxe | Очищает текущую конфигурацию PXE для указанного хоста. Если параметр hostname не передан, используется ID сервера. |
console | Запрашивает запуск консоли управления сервером через IPMI/NoVNC |
create_backup | Инициирует процесс создания резервной копии для указанного сервера. Операция выполняется асинхронно. |
create_pxe | Инициирует процесс создания конфигурации для переустановки сервера через PXE. Поддерживает настройку hostname, SSH-ключей и скриптов post-install. |
delete_backup | Удаляет указанный бэкап сервера по его имени |
deploy | Запускает процесс развертывания (деплоя) существующего сервера по его ID или из пресета. Поддерживает выбор ОС, настройку параметров диска, SSH-ключей и кастомных доменов. |
get_ipmi | Возвращает список доступных IPMI интерфейсов для указанного сервера, включая IP-адрес и модель (vendor). |
get_traffic | Возвращает данные об использовании IPv4 трафика для указанного сервера |
get_upgrade_key | Возвращает ключ апгрейда для сервера, привязанный к конкретному инвойсу через теги |
getserversforannounce | Возвращает список доступных серверов (статусов rent или power_off), подходящих под ограничения по маскам IPv4, принадлежащих текущему владельцу или его субсчету. |
groups | Возвращает список групп для указанного сервера |
hard_off | Отправляет запрос на принудительное выключение (hard stop) или перезагрузку оборудования через IPMI/OpenStack. |
history | Возвращает историю событий сервера. |
list | Возвращает список доступных серверов и оборудования с поддержкой расширенного поиска по различным параметрам (локация, статус, тип, IP, MAC и др.) |
off | Выключает сервер. |
on | Включает сервер. |
order_instance | Запускает процесс развертывания нового сервера из пресета или переустановку существующего сервера с выбором ОС, программного обеспечения и параметров сети. |
ovirt_novnc | Запрашивает запуск консоли noVNC для сервера через интерфейс oVirt. Требует наличия прав доступа к серверу. |
reboot | Отправляет запрос на перезагрузку оборудования. Если сервер находится в режиме ожидания, может потребоваться подтверждение через callback. |
reinstall | Запускает процесс подготовки к переустановке сервера (создание PXE-конфигурации). Возвращает ключ операции и статус этапа. |
remove_ipmi_user | Удаляет дополнительного пользователя IPMI для указанного сервера. |
request_backup_link | Запрашивает генерацию временной ссылки для скачивания резервной копии сервера. |
restore_backup | Запускает процесс восстановления сервера из указанного бэкапа. Операция является асинхронной и возвращает callback для отслеживания статуса. |
search | Возвращает список доступных серверов и инстансов по различным критериям фильтрации (группа, локация, статус, IP, MAC, тип и др.) |
sensors | Возвращает текущие показания датчиков (температура, скорость вращения и т.д.) для указанного сервера |
set_pin | Устанавливает PIN-код для операций. |
show | Возвращает подробную информацию о сервере, включая аппаратное обеспечение (hwconfig), операционную систему, IP-адреса, интерфейсы и IPMI. |
status | Возвращает текущий статус оборудования, включая данные о состоянии (power_off, rent и т.д.), конфигурацию железа, IP-адреса, интерфейсы и IPMI. |
status_check | Возвращает текущий статус оборудования (доступность, состояние и т.д.) без необходимости авторизации. |
suspend | Запрашивает приостановку (suspend) или возобновление (unsuspend) обслуживания сервера. Для выполнения операции требуется наличие прав доступа и, в некоторых случаях, проверка на блокировку администратором. |
traffic_add | Увеличивает лимит исходящего трафика для сервера и создает соответствующий счет в WHMCS. |
unified_server_search | Единый поиск серверов по запросу. |
unit_reset | Запрашивает сброс (reset) модуля IPMI для указанного сервера. Если запрос выполняется успешно, возвращается callback-ключ для отслеживания задачи. |
unsuspend | Разблокирует сервер (unsuspend), если он был ранее заблокирован администратором. |
update_servers | Обновляет список доступных серверов, привязанных к аккаунту клиента в WHMCS, включая активные, приостановленные и ожидающие оплаты услуги. |
eq_callback.php¶
Модуль обработки асинхронных ответов от worker-ов для управления оборудованием (EQ) и виртуальными машинами. Обрабатывает статусы задач (deploy, reinstall, backup, network), обновляет биллинг и отправ
| Метод | Описание |
|---|---|
check | Проверяет статус выполнения асинхронной задачи (job) по ключу. Возвращает текущее состояние, контекст и отладочную информацию. |
reinstall | Запускает процесс переустановки операционной системы на сервере. Если в запросе указан параметр deploy_options=reinstall, выполняется полная очистка тегов и конфигурации после завершения. |
ip.php¶
Модуль управления IP-адресами и сетевой инфраструктурой: получение информации об IP, управление PTR-записями, отслеживание трафика, работа с подсетями и VLAN.
| Метод | Описание |
|---|---|
get_client_ip | Возвращает текущий IP-адрес клиента, совершившего запрос к API |
get_ip | Возвращает полную информацию о сетевых настройках конкретного IP-адреса (маска, сеть и т.д.) |
get_ptr | Проверяет, принадлежит ли указанный IP-адрес серверу с заданным ID, и возвращает текущую PTR-запись для этого IP в указанной локации. |
get_traffic | Возвращает данные о входящем и исходящем трафике для указанного IP-адреса за выбранный период. Может возвращать как сводную информацию (summary), так и детальные временные метки. |
list_free_ip | Возвращает список неиспользуемых IP-адресов для указанной локации на основе тегов Route Reflector. Используется внутренними механизмами для предотвращения сканирования. |
set_main | Устанавливает указанный IP-адрес в качестве основного (main) для сетевого интерфейса сервера. |
update_ptr | Обновляет обратную DNS-запись (PTR) для IP-адреса, принадлежащего серверу. Требуется проверка прав доступа и принадлежности IP серверу. |
iso.php¶
Модуль управления ISO-образами: загрузка, удаление, монтирование и размонтирование образов на серверах, а также получение списков доступных и загруженных образов.
| Метод | Описание |
|---|---|
add | Добавляет новый ISO-образ или обновляет существующий по имени. |
delete | Удаляет ISO-образ по ID. |
list_iso | Возвращает список доступных ISO-образов. |
mount_iso | Монтирует ISO-образ на указанный сервер. |
unmount_iso | Размонтирует ISO-образ с указанного сервера. |
upload | Загружает ISO-образ по URL. |
uploaded | Возвращает список загруженных ISO-образов для клиента или сотрудника. |
jenkins.php¶
Модуль интеграции с Jenkins для управления задачами: получение списка доступных задач и их выполнение для серверов.
| Метод | Описание |
|---|---|
get_tasks | Возвращает список доступных задач Jenkins, доступных для текущего пользователя или клиента. |
jira.php¶
Модуль интеграции с Jira для создания тикетов поддержки по управлению серверами (питание, перезагрузка, KVM) и запросам на помощь продажам.
| Метод | Описание |
|---|---|
request_PXEboot | Создает тикет в Jira для ручной загрузки сервера с PXE, если отсутствует удаленное управление. |
request_assistance | Отправляет запрос на техническую или коммерческую помощь через создание тикета в Jira, проверяя наличие дубликатов и собирая данные о сервере и биллинге. |
request_check | Создает тикет в Jira для проверки и загрузки сервера в ОС при отсутствии удаленного управления. |
request_kvm | Создает тикет в Jira для подключения IP KVM к серверу. |
request_poff | Создает тикет в Jira для ручного выключения питания сервера. |
request_pon | Создает тикет в Jira для ручного включения питания сервера. |
request_reboot | Создает тикет в Jira для ручной перезагрузки сервера. |
nat.php¶
Модуль управления статическим NAT: добавление и удаление правил проброса IP-адресов через MikroTik.
| Метод | Описание |
|---|---|
add_static_nat | Создает статический NAT passthrough через Microtic для указанного сервера с поддержкой ACL и TTL. |
remove_static_nat | Удаляет статический NAT passthrough для указанного сервера или белого IP. |
net.php¶
Модуль управления сетевой инфраструктурой: добавление и удаление IP-адресов, блокировка трафика, управление состоянием сетевых портов, получение статистики и отображение графиков Cacti.
| Метод | Описание |
|---|---|
add_ipv4 | Добавляет указанное количество IPv4 адресов к серверу или назначает конкретные IP-адреса. Поддерживает автоматический поиск свободных IP в VLAN или ручное указание списка. |
block_ip | Блокирует указанный IP-адрес на сервере через BIRD или blackhole. Требует аутентификации. |
get_status | Возвращает текущий статус и конфигурацию сетевого порта сервера. Требует аутентификации. |
port_off | Отключает указанный сетевой порт сервера и добавляет тег блокировки с указанной причиной. |
port_on | Включает указанный сетевой порт сервера, снимая блокировку (tag 'block'), если она не установлена администратором. |
remove_ipv4 | Удаляет указанный IPv4 адрес с сервера. Если передан флаг remove_all, удаляет все адреса. |
show_cacti | Возвращает данные графика мониторинга трафика для указанного сервера и порта из системы Cacti. |
show_ipv4_free | Возвращает список доступных IPv4 адресов для указанного сервера и интерфейса в заданной VLAN. Требует аутентификации. |
unblock_ip | Снимает блокировку с указанного IP-адреса на сервере. Требует проверки прав доступа. |
os.php¶
Модуль управления операционными системами: предоставляет методы для добавления, удаления, обновления и получения списка ОС с фильтрацией по совместимости оборудования и лицензиям.
| Метод | Описание |
|---|---|
list | Возвращает список операционных систем. При указании id или instance_id фильтрует ОС по совместимости с оборудованием или пресетом. Возвращает также список исключенных ОС. |
pdns.php¶
Модуль управления DNS-записями и зонами: добавление, удаление и просмотр доменов, поддоменов и зон, а также получение информации о callback-URL.
| Метод | Описание |
|---|---|
add_dns | Добавляет новую DNS-запись в указанную зону. |
add_domain | Добавляет новый домен в систему DNS для указанного клиента. |
delete_dns | Удаляет указанную DNS-запись. |
delete_domain | Удаляет домен и все связанные с ним записи. |
get_cb_url | Возвращает URL для callback-уведомлений. |
list_domains | Возвращает список доменов клиента. |
list_zones | Возвращает список DNS-зон для указанного клиента или сотрудника |
view_zone | Возвращает информацию о конкретной зоне DNS для клиента или сотрудника |
presets.php¶
Модуль управления пресетами серверов: получение списков, группировка, поиск подходящих серверов и детализация конфигураций с ценами в разных валютах.
| Метод | Описание |
|---|---|
groups | Возвращает список доступных групп пресетов |
info | Возвращает список доступных валют для отображения цен пресетов. По умолчанию возвращает EUR и RUB. |
list | Возвращает список доступных пресетов серверов с фильтрацией по локации и правам доступа |
search | Возвращает список серверов, подходящих под заданные параметры пресета (имя, локация, область поиска) |
show | Возвращает информацию о пресете по ID или имени. Поддерживает фильтрацию и лимиты. |
rhr.php¶
Модуль управления заявками на удаленные работы (Remote Hands Requests): создание, фильтрация, обновление статусов и коммуникация по заявкам.
| Метод | Описание |
|---|---|
add | Создает новую заявку на удаленную работу (RHR) с указанием типа и оборудования. |
chat | Добавляет видимое клиенту сообщение в историю заявки. |
discard | Рекурсивно меняет статус заявки на отмененную или закрытую. |
list | Возвращает список доступных задач RHR с фильтрацией по локации, статусу и дате. |
s3.php¶
Модуль управления S3-хранилищем: создание и удаление аккаунтов, управление бакетами и файлами, получение статистики использования, управление тарифными планами и биллингом.
| Метод | Описание |
|---|---|
cancel_payment_account_deletion | Отменяет процесс удаления S3-аккаунта, инициированный через запрос на удаление. Восстанавливает статус сервиса. |
create_account | Создает новый S3 аккаунт на основе выбранного тарифного плана, проверяет лимиты бесплатных аккаунтов и кредиты пользователя, а также создает заказ в биллинговой системе. |
create_bucket | Создает новый S3 bucket для существующего аккаунта пользователя. Требуется наличие активного s3uid, принадлежащего клиенту. |
create_order | Создает новый S3 аккаунт (bucket) для пользователя, привязывает его к тарифному плану и оформляет заказ в биллинговой системе. |
delete_account | Удаляет S3 аккаунт пользователя, аннулирует связанные сервисы и проводит аудит действий |
delete_bucket | Удаляет указанный S3 bucket, предварительно проверив его принадлежность пользователю и наличие в списке доступных бакетов. |
delete_file | Удаляет указанный файл из S3 бакета. Требуется валидный s3uid владельца аккаунта. |
delete_payment_account | Запрашивает отмену подписки и удаление S3 аккаунта. Если действие успешно, сервис переводится в статус отмены. |
get_buckets | Возвращает список S3 бакетов, информацию о трафике и снапшотах для указанного аккаунта |
get_buckets_rmq | Возвращает список бакетов пользователя, информацию об использовании хранилища (usage), данные биллинга и учетные данные доступа к S3. |
get_files | Возвращает список файлов и папок в указанном S3 бакете с поддержкой пагинации через continuation token |
get_users | Возвращает список S3 аккаунтов с детальной информацией о тарифах, трафике и использовании хранилища. Поддерживает фильтрацию по plan_id, email, s3uid, billing и локации. |
history | Возвращает историю действий, связанных с конкретным ID (вероятно, аккаунтом или пользователем) |
list_plans | Возвращает список доступных S3 планов с учетом налоговой ставки (VAT) и валюты пользователя. Для администраторов может возвращать конкретный план по ID. |
show_key | Возвращает расшифрованный секретный ключ или публичный доступный ключ S3 для указанного аккаунта |
software.php¶
Модуль управления программным обеспечением: предоставляет методы для получения списка доступного ПО с фильтрацией по характеристикам сервера или пресета, а также подбор совместимых пресетов и операцио
| Метод | Описание |
|---|---|
list | Возвращает список программного обеспечения, подходящего для конкретного сервера (id) или пресета (instance_id), с учетом лицензий, характеристик оборудования и промо-акций. |
stocks.php¶
Модуль управления серверами на складе: предоставление списков доступных серверов с фильтрацией по локациям и группам, а также детализированная информация о конкретном сервере.
| Метод | Описание |
|---|---|
list | Возвращает список доступных серверов на складе с возможностью фильтрации по локации и группе. |
show | Возвращает детальную информацию о конкретном сервере по его идентификатору. |
tags.php¶
Модуль управления метками (tags) для компонентов инфраструктуры: добавление, удаление, очистка, поиск и отображение списков тегов для серверов и переменных.
| Метод | Описание |
|---|---|
add | Добавляет пользовательский тег к серверу или компоненту. Поддерживает массовое добавление через список ID. |
clear | Очищает все или неэссенциальные метки от компонента. Для клиентов доступны только публичные метки. |
get | Получает метки для компонента. (Реализация в коде пуста, метод в whitelist) |
list | Возвращает список тегов для конкретного сервера или компонента. Для клиентов доступно ограничение по типу компонента (eq, vars). |
remove | Удаляет тег по его имени для конкретного компонента или удаляет все указанные теги из списка ID. Если передан id_list, операция выполняется массово. |
search | Ищет компоненты, соответствующие конкретной метке и значению. |
search_user | Ищет оборудование пользователя по значению метки. Используется в глобальной форме поиска. |
show | Показывает возможные метки для компонента. (Реализация в коде пуста, метод в whitelist) |
traffic_plans.php¶
Модуль управления тарифными планами трафика: создание, удаление, обновление и получение списка доступных планов с фильтрацией по серверу или локации и конвертацией цен.
| Метод | Описание |
|---|---|
list | Возвращает список подходящих тарифных планов трафика для указанного сервера (id) или локации (location). Поддерживает фильтрацию по типу оборудования и конвертацию цен в EUR/USD/RUB. |
vm.php¶
Модуль управления виртуальными машинами (VM), предоставляющий API для создания, получения, удаления и восстановления снапшотов, а также загрузки статистики.
| Метод | Описание |
|---|---|
create_snapshot | Инициирует создание снапшота для указанной виртуальной машины. Возвращает ключ задачи для отслеживания статуса. |
get_snapshot | Возвращает список снапшотов и настройки для указанной виртуальной машины. |
load_stats | Инициирует загрузку статистики использования ресурсов для виртуальной машины. |
remove_snapshot | Инициирует удаление снапшота с указанным именем. |
restore_snapshot | Инициирует восстановление состояния виртуальной машины из снапшота. |
update_restore_settings | Обновляет настройки автоматического восстановления и ротации снапшотов для указанной виртуальной машины. |
whmcs.php¶
Модуль интеграции с WHMCS для управления клиентами, счетами, кредитом, отменами заказов и биллинговыми данными серверов.
| Метод | Описание |
|---|---|
add_contact | Добавляет нового дополнительного контакта для клиента в WHMCS. Если тип запроса не указан, создается случайный контакт с рандомным email. |
apply_credit | Применяет доступный баланс (кредит) клиента для оплаты выбранного счета в WHMCS. Если счет после оплаты переходит в статус 'Paid', автоматически очищается оверраж трафика. |
create_addfunds | Создает инвойс в WHMCS для пополнения баланса клиента. Если включена опция subscribe, будет настроено автоматическое продление. |
delete_cancellation_request | Удаляет существующий запрос на отмену для конкретного сервера, позволяя восстановить статус инвойса или сгенерировать новый. |
delete_contact | Удаляет дополнительный контакт, привязанный к клиенту в WHMCS. |
download_invoice | Возвращает PDF-файл инвойса в формате base64 для просмотра или скачивания. |
generate_due_invoice | Генерирует следующий счет для оплаты (due invoice) в WHMCS. Блокируется, если у клиента есть неоплаченные счета или если текущий цикл оплаты еще не завершен. |
get_billing_data | Возвращает подробную информацию о биллинговых параметрах конкретного сервера, включая данные для EU B2C (право на возврат) и детализацию лицензий в случае отмены по правилам ЕС. |
get_cancellation_requests | Возвращает список активных запросов на отмену услуг для конкретного сервера или пользователя с фильтрацией по дате, типу и статусу оплаты. |
get_client | Возвращает подробную информацию о авторизованном клиенте, включая данные из WHMCS (профиль, группа, валюта) и внутренние данные системы (теги, статус верификации). При параметре full возвращается расширенный набор данных. |
get_clientgroups | Возвращает список доступных групп клиентов из WHMCS для указанной локации. |
get_contacts | Возвращает список дополнительных контактов, привязанных к клиенту в WHMCS. Если указан email subaccount, возвращаются только те контакты, которые имеют соответствующие права доступа. |
get_invoice | Возвращает детальную информацию о счете из WHMCS, включая данные клиента и список позиций (items). |
get_invoices | Возвращает список всех инвойсов, связанных с клиентом в WHMCS. Если клиент авторизован, возвращаются только его инвойсы. |
get_related_invoices | Возвращает список инвойсов, связанных с конкретным сервером или аккаунтом клиента в WHMCS |
getcredits | Возвращает информацию о доступных кредитах на счету клиента в указанной локации WHMCS. |
getpaymentgw | Возвращает список доступных методов оплаты (платежных шлюзов) для конкретного инвойса с поддержкой форматирования ссылок и HTML-кода кнопок. |
mass_pay | Создает один общий инвойс для оплаты нескольких выбранных инвойсов клиента. |
request_cancellation | Инициирует процесс отмены заказа или подписки в WHMCS. Проверяет наличие активных лицензий, статус оплаты инвойсов и возможность возврата средств (включая правила EU B2C). При наличии задолженностей по трафику может рассчитать сумму удержания. |
request_subscription_cancellation | Инициирует процесс отмены банковской подписки для сервера, создавая тикет в JIRA и помечая сервер соответствующим тегом. |
reset_password | Позволяет инициировать процесс сброса пароля (отправка ссылки на email) или завершить его, используя токен восстановления и 2FA код. |
transactions | Возвращает список финансовых транзакций пользователя из WHMCS по указанному ID или в рамках текущей сессии. |
update_client | Обновляет информацию о клиенте в WHMCS и локальной базе данных, включая контактные данные, настройки 2FA, IP-ACL и кастомные поля (custom fields). При изменении email или телефона может потребоваться повторная верификация. |
update_contact | Обновляет данные существующего контакта клиента (имя, фамилия, email, телефон) в системе WHMCS. При изменении email или телефона может потребоваться повторная верификация. |