Справочный центр Wialon

use_auth_hash

Чтобы войти в систему с помощью хэша авторизации, используйте метод core/use_auth_hash. Получите хэш с помощью метода core/create_auth_hash и укажите его в параметре authHash. Этот метод можно использовать вместо метода core/duplicate.

Конечная точка

Copied!
svc=core/use_auth_hash&params={
  "authHash": <text>,
  "operateAs": <text>,
  "appName": <text>,
  "checkService": <text>
}

Параметры

Параметр authHash является обязательным. Остальные параметры необязательны.

Параметр Описание
authHash Хэш авторизации, который можно получить с помощью метода core/create_auth_hash.
operateAs Имя нижестоящего пользователя, от имени которого необходимо войти в систему. У вас должно быть право доступа Выполнение действий от имени пользователя на этого пользователя.
appName Название приложения. Записывается в логи сервера.
checkService Название услуги, которую необходимо проверить в тарифном плане пользователя. Список услуг можно получить с помощью метода account/get_account_data (см. раздел Список услуг).

Ответ

В случае успешного выполнения запроса возвращается ответ следующего формата:

Copied!
{
    "eid": <text>,                  /* ID сессии. */
    "gis_sid": <text>,              /* ID сессии для GIS-сервисов. */
    "host": <text>,                 /* Хост. */
    "hw_gw_ip": <text>,             /* IP-адрес сервера, на который устройства отправляют данные. */
    "au": <text>,                   /* Имя пользователя. */
    "hl": <int>,                    /* Наличие ID входа. При наличии поля — true (значение всегда 1). */
    "tm": <uint>,                   /* Текущее время (UTC). */
    "wsdk_version": <text>,         /* Версия SDK. */
    "base_url": <text>,
    "hw_gw_dns": <text>,            /* Доменное имя сервера, на который устройства отправляют данные. */
    "gis_search": <text>,           /* URL-адрес поиска GIS. */
    "gis_render": <text>,           /* URL-адрес отрисовки GIS. */
    "gis_geocode": <text>,          /* URL-адрес геокодирования GIS. */
    "gis_routing": <text>,          /* URL-адрес маршрутизации GIS. */
    "token": <text>,                /* Токен сессии. */
    "th": <text>,                   /* Хэш токена. */
    "web_site": <text>,             /* URL-адрес системы мониторинга Wialon. */
    "web_cms_manager_site": <text>, /* URL-адрес системы управления Wialon. */
    "user": {                       /* Пользователь, от имени которого необходимо войти в систему. */
        "nm": <text>,               /* Имя. */
        "cls": <uint>,              /* ID суперкласса "user". */
        "id": <long>,               /* ID. */
        "prp": {                    /* Произвольные свойства, например: */
            "dst": <text>,          /* Переход на летнее время. */
            "language": <text>,     /* Язык (двухбуквенный код). */
            "msakey": <text>,       /* Ключ доступа к мобильному сайту. */
            "pcal": <text>,         /* Иранский календарь. */
            "tz": <text>,           /* Часовой пояс. */
            "us_units": <text>,     /* Американские единицы измерения (мили и галлоны). */
            ...
        },
        "crt": <uint>,              /* ID создателя. */
        "bact": <uint>,             /* ID учетной записи. */
        "fl": <uint>,               /* Флаги пользователя. */
        "hm": <text>,               /* Маска хостов. */
        "uacl": <uint>,             /* Доступ пользователя к самому себе. */
        "mu": <uint>,               /* Система мер. */
        "ct": <uint>,               /* Дата создания пользователя. */
        "ftp": {<text>},            /* Настройки FTP-сервера. */
        "ld": <uint>,               /* Дата предыдущего входа. */
        "pfl": <uint>,              /* Флаг создателя. */
        "ap": {                     /* Настройки двухфакторной аутентификации. */
            "type": <uint>,         /* Тип аутентификации (0 — нет, 1 — email, 2 — SMS). */
            "phone": <text>         /* Номер телефона. */
        },
        "mapps": {<text>},          /* Список мобильных приложений. */
        "mappsmax": <int>           /* Ограничения для мобильных приложений, указанные в тарифном плане. */
    },
    "classes": {                    /* Суперклассы, доступные текущему пользователю (ключ — имя суперкласса, значение — ID суперкласса): */
        "avl_hw": <uint>,           /* Тип оборудования. */
        "avl_resource": <uint>,     /* Ресурс. */
        "avl_retranslator": <uint>, /* Ретранслятор. */
        "avl_unit": <uint>,         /* Объект. */
        "avl_unit_group": <uint>,   /* Группа объектов. */
        "user": <uint>,             /* Пользователь. */
        "avl_route": <uint>         /* Маршрут. */
    },
    "features": {
        "unlim": <bool>,            /* Тип тарифного плана: 0 — обычный, 1 — специальный (для разработки/тестирования). */
        "svcs": {                   /* Хэш-коллекция разрешенных услуг; если услуга здесь не указана, она запрещена. */
            "<service_name>": <bool>, /* Ключ — имя услуги; значение: 0 — услуга доступна, но достигнут лимит, 1 — услуга доступна и может использоваться. */
            ...
        }
    }
}

Флаги пользователя описаны на странице update_user_flags.

Подробнее о настройках FTP читайте на странице update_ftp_property.

В случае неудачного выполнения запроса возвращается код ошибки.

Коды ошибок

Код ошибки Описание
4 Неверные входные параметры.
6 Внутренняя ошибка сервера.
7 Доступ запрещен.
8 Ошибка входа.
1003 Подробности см. в поле reason.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.