API
Материал из Hivext Wiki
Содержание |
HiAPI
Регистрация
Activate
Активация нового пользователя.
CreateAccount
Регистрация нового пользователя.
CheckEmailExist
Проверка существования почтового адреса в сети.
CheckEmailRegistration
Проверка наличия почтового адреса в базе пользователей.
Идентификация и аутентификация
Signin
Аутентификация пользователя.
Signout
Завершение сеанса пользователя.
GetDeviceSignature
Получить подпись устройства.
CheckSign
Проверка состояния пользовательской сессии.
ChangeSession
Принудительная смена идентификатора сессии.
Управление аккаунтом
ChangeEmail
Редактирование почтового адреса.
ChangePassword
Редактирование пароля.
ChangeName
Редактирование имени.
GetUserInfo
Получение информации о пользователе.
RecoverPassword
Восстановление забытого пароля.
Структуры
DefineType
Определение нового типа данных.
UndefineType
Удаление типа данных.
GetType
Получение информации о типе.
GetTypes
Получение информации о всех типах для заданного приложения.
GetTypesCount
Получение общего количества типов для заданного приложения.
AddField
Добавить поле в указанный тип данных.
RemoveField
Удалить поле из указанного типа данных.
RenameField
Переименовать поле для указанного типа данных.
SetUniqueFields
Указать уникальные поля в типе данных.
GetUniqueFields
Получение информации о уникальных полях типа данных.
CreateObject
Создание объекта.
DeleteObject
Удаление объекта.
DeleteObjectsByCriteria
Удаление множества объектов по заданным критериям.
SetObject
Запись данных в объект.
GetObject
Получение объекта.
GetObjects
Получение множества объектов.
GetObjectsByCriteria
Получение множества объектов по заданным критериям.
GetObjectsCount
Получение общего количества объектов заданного типа и критерия.
SetProperty
Записать значение в свойство объекта.
GetProperty
Прочитать значение из свойства объекта.
SerializeObjects [доступ ограничен]
Сериализация объектов.
DeserializeObjects [доступ ограничен]
Десериализация объектов.
Управление доступом
CreateRole
Создание новой роли.
DeleteRole
Удаление роли.
GetRoles
Взять все роли для приложения.
AddPolicy
Добавление прав доступа к объекту для указанной роли.
RemovePolicy
Удаление прав доступа к объекту для указанной роли.
GetPolicy
Взять все права доступа к объектам для указанной роли.
ApplyRole
Применить роль к субъектам доступа (приложениям или пользователям).
RemoveRole
Удалить роль у субъектов доступа (приложений или пользователей).
GetRolesBySubject
Отобразить все роли для указанного субъекта доступа.
GetSubjectsByRole
Отобразить все субъекты для указанной роли.
GetRolesByObject
Отобразить все роли для указанного объекта доступа.
GetObjectsByRole
Отобразить все объекты для указанной роли.
SetRights
Запись прав в таблицу ACL для субъекта и объекта доступа.
GetRights
Информация о правах из таблицы ACL для субъекта и объекта доступа.
GetRightsBySubject
Информация о правах из таблицы ACL для субъекта доступа.
GetRightsByObject
Информация о правах из таблицы ACL для объекта доступа.
RemoveRights
Удаление прав из таблицы ACL для субъекта и объекта доступа.
RemoveRightsBySubject
Удаление прав из таблицы ACL для субъекта доступа.
RemoveRightsByObject
Удаление прав из таблицы ACL для объекта доступа.
CheckRights
Проверка прав для субъекта и объекта доступа.
Файловое хранилище
Upload
Загрузка данных в файловое хранилище.
Abort
Отмена загрузки файла.
Progress
Получение информации о процессе загрузки файла.
Управление приложениями
GenerateApp
Генерация нового идентификатора приложения.
DeleteApp
Удалить идентификатор приложения.
GetApps
Получить информацию о приложениях для заданного разработчика.
ChangeAppInfo
Изменить информацию о приложении.
GetAppInfo
Получить информацию о приложении по идентификатору.
CreateAppsPool [доступ для разработчиков]
Создание пула приложений.
DeleteAppsPool [доступ для разработчиков]
Удаление пула приложений.
GetAppsPools [доступ для разработчиков]
Получить информацию о пуле приложений.
AddAppToPool [доступ для разработчиков]
Добавить приложение в пул приложений.
RemoveAppFromPool [доступ для разработчиков]
Удалить приложение из пула приложений.
RebuildApp [доступ для разработчиков]
Пересоздать (перегенерировать) приложение с сохранением всех созданных типов и объектов.
SetAppPermission
Установка прав доступа к информации о приложении для других пользователей (разработчиков).
GetAppPermission
Узнать права доступа к информации о приложении для других пользователей (разработчиков).
AllowAppAccess
Разрешить работу с сессиями полученными в других приложениях.
RemoveAppAccess
Запретить работу с сессией для других приложений.
GetAppAccess
Узнать каким приложениям разрешена работа с сессией.
Скриптинг серверной логики
CreateScript
Создать скрипт.
DeleteScript
Удалить скрипт.
GetScripts
Взять все скрипты для указанного приложения.
GetScript
Взять скрипт по имени для указанного приложения.
ChangeScript
Изменить скрипт.
GetEngineInfo
Получить информацию о виртуальных машинах.
Eval
Исполнение скрипта.
EvalCode
Исполнение скрипта.
Пакетные вызовы
Call
Вызов множества методов платформы за один запрос.
LoAPI
GetParam
Получить значение переменной по ее названию.
SetHeader
Установить значение поля в HTTP заголовке ответа.
GetHeader
Получить значение поля из HTTP заголовка запроса.
SetCookie
Установить значение переменной в cookie.
GetCookie
Получить значение переменной из cookie.
Redirect
Перенаправить на интернет адрес.
SetSessionVar
Установить значение сессионной переменной.
GetSessionVar
Получить значение сессионной переменной.
Write
Записать данные в буфер вывода.
Flush
Принудительная отправка данных из буфера на клиент.
GetDeviceSignature
Запросить локальную подпись.
ReturnResult
Возврат результата.
toJSON
Кодирование объекта в JSON формат.
toNative
Преобразование объекта в родной формат скриптового движка.
MD5
Получение MD5 хеша.
