Описание интерфейса (API)
|
Описание интерфейса (API) |
|
Для использования API автоматизации надо сначала настроить аутентификацию через API. Есть 2 способа аутентификации -
| • | Через функцию APILogon2. Для этого надо прописать соответствующего пользователя в настройках администрирования консоли. Рекомендуемый вариант, позволяет сделать разграничения доступа. |
| • | Через функцию APILogon. Для этого надо разрешить и прописать API пароль. |
Для инициализации интерфейса используется строка ClassId "TrafInsp.TrafInspAdmin". Для VB это выглядит так:
Set Srv = CreateObject("TrafInsp.TrafInspAdmin")
Дальше необходимо произвести аутентификацию, иначе все дальнейшие операции будут недоступны:
Srv.APILogon("Password")
или
Srv.APILogon2("UserName", "Password", unassigned)
После аутентификации и авторизации через API в права доступа могут быть ограничены, в соответствии с настройками пользователя. Соответственно функции API, возвращающие списки групп и клиентов, будут возвращать только те, для которых разрешен доступ. Некоторые операции могут быть недоступны.
Функции, доступные для вызова через интерфейс (API версии 1) :
Чтение данных тарификации |
|
Запись данных тарификации |
|
Чтение состояния пользователя |
|
Запись состояния пользователя |
|
Чтение атрибутов |
|
Запись атрибутов |
|
Запись состояния пользователя в журнал |
|
Чтение данных фильтра |
|
Запись данных фильтра |
|
Чтение файлов журнала |
|
Чтение файлов журнала в XML формате |
|
Вариант APIReadLogXML |
|
Сброс внешних счетчиков |
|
Преобразование IP-адресов или имен через DNS |
|
Запрос об IP-адресе через службу WhoIs или NetGeo |
|
Получение символического имени атрибута |
|
Поиск атрибута по символическому имени |
|
Получение описания кода блокировки |
|
Получение описания типа учета трафика |
|
Получение описания режима работы клиента |
|
Получение описания состояния сессии клиента |
|
Получение описания сервиса |
|
Получение описания набора сервисов |
|
Получение описания IP-протоколов |
|
Получение описания протоколов приложений |
|
Добавление пользователя |
|
Удаление пользователя |
|
Сохранение данных всех пользователей |
|
Авторизация пользователя |
|
Отключение авторизации пользователя |
|
Отправляет сообщения клиентскому агенту |
|
Определяет MAC адрес по IP адресу |
Функции, доступные для вызова через интерфейс (API версии 2) :
Выводит различные списки данных в виде XML |
|
Обновляет данные в списках |
|
Добавляет новые элементы в списках |
|
Удаляет элементы из списков |
|
Чтение различных данных |
|
Запись различных данных и некоторые операции управления |
|
Просмотр списка объектов кэша прокси сервера |
|
Чтение объекта кэша прокси сервера |
|
Удаление объекта кэша прокси сервера |
|
Экспорт описания |
|
Импорт описания |
|
Операции обслуживания описаний |
|
Проверка описания на условие |
|
Создание и установка в системе серверного сертификата |
|
Чтение данных текущей сетевой статистики |
При вызове многих функций используется идентификатор объекта. Это может быть как его отображаемое имя, так и GUID - уникальный идентификатор. Использование GUID ненаглядно, но предпочтительно, так как объект может быть переименован, а GUID будет неизменен за все время его жизни.
GUID объектов по умолчанию в таблицах не отображается, эта колонка скрыта. Для его получения используйте операцию Копировать GUID в буфер меню консоли.
Также отметим, что для пользователя его отображаемое имя явно может быть не задано. В этом случае оно будет генерироваться на основе его идентификатора - логина, IP-адреса, MAC или E-Mail.
Многие параметры и значения представляют собой перечисления. Для получения описаний этих значений при формировании отчетов в API предусмотрен набор функций, позволяющих их удобно расшифровать.
Текущая страница справки: help.smart-soft.ru/index.html?apidesc.htm