Документация 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 | Запрашивает повторную отправку кода двухфакторной аутентификации для пользователя. Если пользователь находится в режиме отладки, код возвращается в ответе. |
billing_list | Возвращает список доступных платежных систем (биллингов), доступных для текущего пользователя или администратора. |
email_check | Проверяет валидность email, отправляет код верификации или проверяет уже существующий код/токен для подтверждения адреса. |
flip_tag | Создает или удаляет указанный тег у пользователя. Если тег уже существует, он будет удален; если не существует — создан. |
get_log | Возвращает лог событий авторизации за указанный период или по токену. |
get_log_details | Возвращает подробную информацию о событиях аутентификации для текущего пользователя (через user_token) |
github_init | Возвращает необходимые данные для инициализации авторизации через GitHub (client_id и redirect_uri) |
github_signin | Инициирует процесс авторизации через GitHub. Генерирует временный state и токен для последующего обмена кода на сессию. |
google_signin | Выполняет вход в систему с использованием Google ID Token. Если токен уже привязан к пользователю, метод связывает текущую сессию с этим аккаунтом. |
info | Возвращает подробную информацию о текущей сессии пользователя, включая роль, права доступа (permissions), данные клиента и список активных серверов. |
login | Авторизация через API-ключ клиента. Возвращает токен доступа, роль пользователя и список доступных серверов. |
logout | Очищает текущий токен доступа (access token) |
session_reset | Завершает все активные сессии пользователя, соответствующие предоставленному токену сброса, и очищает связанные теги. |
set_tag | Создает или удаляет тег у клиента. Позволяет устанавливать значения для определенных параметров (например, auto_credit) или просто переключать наличие тега. |
tg_verify | Привязывает Telegram username пользователя к его аккаунту и возвращает ссылку на бота для уведомлений. |
vk_init | Инициирует процесс авторизации через социальную сеть ВКонтакте, генерируя временные параметры для OAuth2 (code_challenge, state и др.) |
vk_signin | Выполняет авторизацию пользователя через OAuth2 протокол VK. Обменивает код на токен и связывает аккаунт с пользователем. |
whmcslogin | Выполняет вход в систему с использованием учетных данных WHMCS (email/пароль) или SSO (Google). Возвращает токен сессии, информацию о клиенте, права доступа и статус 2FA. |
eq.php¶
Модуль управления оборудованием (eq.php): API для развертывания серверов, управления питанием, IPMI, резервными копиями, поиска и получения детальной информации о конфигурации оборудования.
| Метод | Описание |
|---|---|
abort_reinstall | Прерывает процесс переустановки сервера, удаляет связанные теги (reinstall_start, autodeploy_start, autodeploy_timeout) и восстанавливает настройки VLAN. |
add_ipmi_admin | Создает нового административного пользователя IPMI для указанного оборудования. Если пользователь уже существует, возвращает его учетные данные. |
add_ipmi_user | Создает нового пользователя IPMI для сервера. Если пользователь является администратором, требуются соответствующие права. |
announceip | Выполняет процедуру объявления (announcement) указанного подсетевого диапазона для сервера. |
backup_get_schedule | Возвращает список запланированных задач резервного копирования для указанного сервера |
backup_list | Возвращает список доступных резервных копий для указанного оборудования (сервера) |
backup_save_schedule | Сохраняет настроенное расписание автоматических резервных копий для указанного сервера |
boot_dev | Запрашивает перезагрузку сервера для загрузки с указанного носителя (PXE или диск) в зависимости от выбранного режима. |
check_backup_lock | Проверяет наличие активной блокировки для выполнения операций с резервными копиями сервера. |
check_pin | Проверяет PIN-код для операций. |
clear_pxe | Очищает конфигурацию PXE для указанного хоста. Если параметр full равен 1, удаляется всё содержимое. |
console | Запрашивает запуск консоли управления сервером через IPMI/NoVNC. |
create_backup | Инициирует процесс создания резервной копии для указанного оборудования. Операция выполняется асинхронно. |
create_pxe | Создает конфигурацию загрузки через PXE для последующей переустановки ОС на сервере. Поддерживает выбор OS, настройку hostname, SSH-ключей и скриптов post-install. |
delete_backup | Удаляет указанный бэкап сервера. Требует выполнения асинхронной задачи. |
deploy | Запускает процесс развертывания (деплоя) выбранного сервера или пресета. Поддерживает выбор ОС, настройку hostname, SSH-ключей и параметров диска. |
get_ipmi | Возвращает список доступных IPMI интерфейсов сервера, включая IP-адрес и модель (vendor). |
get_traffic | Возвращает данные об IPv4 трафике для указанного сервера |
get_upgrade_key | Возвращает ключ апгрейда, привязанный к конкретному счету (invoice_id), если для него найден соответствующий тег upgrade_key. |
getserversforannounce | Возвращает список доступных серверов (тип Server) в статусе rent или power_off, которые прошли проверку на ограничения масок подсетей и доступны для анонсирования IP-адресов. |
groups | Возвращает список групп для указанного сервера |
hard_off | Отправляет запрос на немедленное (жесткое) выключение оборудования через IPMI/контроллер. |
history | Возвращает историю событий сервера. |
list | Возвращает список доступных серверов и оборудования с поддержкой расширенного поиска по различным параметрам (локация, статус, тип, IP, MAC и др.) |
off | Выключает сервер. |
on | Включает сервер. |
order_instance | Запускает процесс развертывания нового сервера из пресета или переустановку существующего сервера с выбором ОС, программного обеспечения и параметров сети. |
ovirt_novnc | Запрашивает запуск консоли NoVNC для сервера в среде oVirt. Требует авторизации и наличия прав на управление оборудованием. |
reboot | Отправляет запрос на перезагрузку оборудования по указанному ID. Если сервер находится в режиме ожидания, может потребоваться выполнение через IPMI. |
reinstall | Запускает процесс подготовки к переустановке сервера, создавая ключ задачи и уведомляя клиента. |
remove_ipmi_user | Удаляет дополнительные учетные записи пользователей IPMI для указанного сервера. |
request_backup_link | Запрашивает временную ссылку для скачивания резервной копии сервера. Метод является асинхронным и возвращает callback-ключ. |
restore_backup | Запускает процесс восстановления сервера из существующего резервного копирования по имени бэкапа. |
search | Возвращает список доступных серверов и оборудования, соответствующих заданным фильтрам (группа, локация, статус, тип, IP, MAC и др.) |
sensors | Возвращает текущие показания сенсоров для указанного сервера (например, температура или состояние дисков) |
set_pin | Устанавливает PIN-код для операций. |
show | Возвращает подробную информацию о сервере, включая аппаратное обеспечение (hwconfig), операционную систему, IP-адреса, интерфейсы и IPMI. |
status | Возвращает текущий статус оборудования и связанные с ним данные (IP, интерфейсы, IPMI, теги) |
status_check | Возвращает текущий статус оборудования (доступен для проверки без авторизации) |
suspend | Запрашивает приостановку (suspend) или разблокировку (unsuspend) VPS/сервера. Если действие unsuspend, сервер будет разблокирован. |
traffic_add | Увеличивает лимит исходящего трафика для сервера и формирует счет на оплату в WHMCS. |
unified_server_search | Единый поиск серверов по запросу. |
unit_reset | Запрашивает выполнение операции сброса (reset) для IPMI-интерфейса указанного сервера. |
unsuspend | Запрос на снятие блокировки (unsuspend) с сервера. Если сервер был заблокирован администратором, действие выполняется немедленно. |
update_servers | Возвращает актуальный список серверов пользователя, включая данные из WHMCS и информацию о деплое. |
eq_callback.php¶
Модуль обработки асинхронных ответов от worker-ов для управления оборудованием (EQ) и виртуальными машинами. Обрабатывает статусы задач (deploy, reinstall, backup, network), обновляет биллинг и отправ
| Метод | Описание |
|---|---|
check | Проверяет текущий статус задачи по ключу (key) и возвращает контекст выполнения, если задача завершена или находится на промежуточном этапе. |
reinstall | Обработчик колбэка от worker-а после завершения операции переустановки (reinstall). Обновляет статус сервера, очищает временные теги, отправляет письмо клиенту с данными доступа и обновляет биллинг. |
ip.php¶
Модуль управления IP-адресами и сетевой инфраструктурой: получение информации об IP, управление PTR-записями, отслеживание трафика, работа с подсетями и VLAN.
| Метод | Описание |
|---|---|
get_client_ip | Возвращает текущий IP-адрес клиента, совершившего запрос к API |
get_ip | Возвращает полную информацию о сетевых настройках конкретного IP-адреса (маска, сеть и т.д.) |
get_ptr | Проверяет, принадлежит ли IP-адрес серверу, и возвращает текущую PTR запись для данного IP в указанной локации. |
get_traffic | Возвращает данные о входящем и исходящем трафике для указанного IP-адреса за выбранный период. Может возвращать как сводную информацию (summary), так и детальные временные метки. |
list_free_ip | Возвращает список неиспользуемых IP-адресов для конкретной локации на основе тегов Route Reflector. Для клиентов доступно только в рамках их собственных подсетей. |
set_main | Устанавливает указанный IP-адрес в качестве основного (main) для сетевого интерфейса сервера. |
update_ptr | Обновляет обратную DNS-запись (PTR) для указанного IP-адреса, при условии, что данный IP закреплен за сервером с заданным ID. |
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 | Возвращает список серверов, подходящих под параметры указанного пресета. Если пользователь не авторизован, поиск ограничен только бесплатными (free) предложениями. |
show | Возвращает информацию о пресете по ID или имени. Поддерживает фильтрацию и лимиты. |
rhr.php¶
Модуль управления заявками на удаленные работы (Remote Hands Requests): создание, фильтрация, обновление статусов и коммуникация по заявкам.
| Метод | Описание |
|---|---|
add | Создает новую заявку на удаленную работу (RHR) с указанием типа и оборудования. |
chat | Добавляет видимое клиенту сообщение в историю заявки. |
discard | Рекурсивно меняет статус заявки на отмененную или закрытую. |
list | Возвращает список доступных задач RHR с фильтрацией по локации, статусу и дате. |
s3.php¶
Модуль управления S3-хранилищем: создание и удаление аккаунтов, управление бакетами и файлами, получение статистики использования, управление тарифными планами и биллингом.
| Метод | Описание |
|---|---|
cancel_payment_account_deletion | Отменяет процесс удаления S3-аккаунта, инициированный из-за проблем с оплатой. Сбрасывает причину приостановки и обновляет даты коммитов. |
create_account | Создает новый S3 аккаунт (bucket) для клиента, привязывает его к тарифному плану и создает соответствующий заказ в биллинге. |
create_bucket | Создает новую корзину (bucket) для существующего аккаунта S3 пользователя. |
create_order | Создает новый S3 аккаунт (bucket) для клиента, привязывает его к тарифному плану и создает соответствующий заказ в биллинговой системе. |
delete_account | Удаляет S3 аккаунт пользователя, выполняет аудит действий и логирует операцию в историю. |
delete_bucket | Удаляет указанную корзину (bucket) из хранилища S3, если она принадлежит пользователю. |
delete_file | Удаляет указанный файл из S3 бакета. Требуется авторизация и наличие прав доступа к аккаунту. |
delete_payment_account | Запрашивает отмену сервиса S3, инициируя процесс удаления/подписки. При успешном выполнении возвращает информацию о дате отмены. |
get_buckets | Возвращает список S3 бакетов пользователя, информацию об использовании трафика и снапшоты. |
get_buckets_rmq | Возвращает список бакетов пользователя, информацию об их использовании (usage), данные биллинга, метрики и учетные данные доступа к S3. |
get_files | Возвращает список файлов и папок в указанном S3 бакете с поддержкой пагинации и поиска |
get_users | Возвращает список пользователей S3 с детальной информацией о тарифах, потреблении трафика и данных сервиса. |
history | Возвращает историю событий (логи) для указанного S3 аккаунта или пользователя |
list_plans | Возвращает список доступных S3 планов с учетом прав пользователя, локации и валюты клиента. Для администраторов доступен просмотр конкретного плана по 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. Если тип запроса не указан, создается случайный контакт. |
apply_credit | Применяет средства с баланса аккаунта (кредит) для оплаты выбранного счета (инвойса). Если счет оплачен кредитом, статус инвойса меняется на Paid. |
create_addfunds | Создает инвойс в WHMCS для пополнения баланса клиента (Add Funds). Поддерживает автоматическое включение автоплатежей. |
delete_cancellation_request | Удаляет существующий запрос на отмену для конкретного сервера, восстанавливая при этом статус инвойсов или позволяя создать новый. |
delete_contact | Удаляет дополнительный контакт, привязанный к клиенту в WHMCS. |
download_invoice | Возвращает PDF-файл инвойса в формате base64. Параметр viewpdf позволяет отобразить файл во встроенном просмотрщике (inline) или скачать как вложение. |
generate_due_invoice | Генерирует следующий счет для оплаты (due invoice) в WHMCS, учитывая текущий цикл оплаты и наличие активных аддонов. |
get_billing_data | Возвращает подробную информацию о биллинге конкретного сервера, включая данные клиента и статус EU withdrawal. |
get_cancellation_requests | Возвращает список активных запросов на отмену услуг для конкретного сервера или пользователя с фильтрацией по типу и статусу оплаты. |
get_client | Возвращает подробную информацию о авторизованном клиенте, включая данные из WHMCS и внутренние теги системы. |
get_clientgroups | Возвращает список доступных групп клиентов из WHMCS для указанной локации биллинга. |
get_contacts | Возвращает список дополнительных контактов для указанного клиента или проверяет права доступа к контактам subaccount. |
get_invoice | Возвращает детальную информацию об инвойсе из WHMCS, включая данные о клиенте и статус оплаты. |
get_invoices | Возвращает список всех инвойсов, связанных с клиентом в WHMCS для указанной локации. |
get_related_invoices | Возвращает список инвойсов, связанных с конкретным сервером (через account_id) |
getcredits | Возвращает информацию о доступном балансе (кредитах) пользователя в WHMCS для указанной локации. |
getpaymentgw | Возвращает список доступных методов оплаты для конкретного инвойса с обработанными ссылками на оплату |
mass_pay | Создает один общий инвойс для оплаты списка выбранных инвойсов клиента. |
request_cancellation | Инициирует процесс отмены заказа/сервера в WHMCS, включая проверку статусов, расчет возвратов и создание тикетов в JIRA. |
request_subscription_cancellation | Отправляет запрос в JIRA для отмены банковской подписки сервера. Проверяет наличие активных подписок и статус оплаты. |
reset_password | Инициирует процесс сброса пароля. Если токен не предоставлен, отправляет ссылку на email. Если токен валиден, позволяет установить новый пароль (с поддержкой 2FA). |
transactions | Возвращает список финансовых транзакций пользователя, связанных с инвойсом или конкретной транзакцией. |
update_client | Обновляет информацию о клиенте в WHMCS, включая персональные данные (имя, email), контактную информацию и кастомные поля профиля. |
update_contact | Обновляет информацию о дополнительном контакте (имя, фамилия, email, телефон) для клиента в WHMCS. Поддерживает проверку уникальности email и верификацию номера телефона. |