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

login

Для работы под токеном используйте метод token/login.

Для получения токена используйте формы, указанные в разделе login.

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

Copied!
svc=token/login&params={
  "token": <text>,
  "operateAs": <text>,
  "fl": <uint>
}

Параметры

Запрос может содержать следующие параметры. Обязательные параметры отмечены звездочкой (*).

Параметр Описание
token* Уникальное имя токена. Состоит из 72 символов.
operateAs Имя подчиненного пользователя для входа. Параметр является необязательным.
fl* Флаги ответа (см. ниже).

Флаги ответа

Параметр fl может содержать следующие флаги:

Флаг в HEX Флаг в DEC Описание
0x1 1 Общая информация.
0x2 2 Информация о пользователе.
0x4 4 Информация о токене.
0x8 8 Информация об элементах.
0x10 16 Информация о тарифицируемых услугах.
0x20 32 Произвольные свойства пользователя.
0x40 64 URL системы мониторинга и системы управления.

Как получить имя токена

Чтобы получить имя токена, выполните одно из следующих действий:

  • Создайте новый токен с помощью метода token/update с "callMode": "create".
  • Если токены уже созданы, выполните метод token/list.

Вы не можете войти в систему с помощью неактивированного токена (параметр at в параметрах токена).

Ответ

Если запрос выполнен успешно, новый параметр token добавляется ко всем параметрам токена в качестве значения. Возвращается ответ следующего формата:

Copied!
{
  "host": <text>,                   /* Хост. */
  "eid": <text>,                    /* ID сессии. */
  "gis_sid": <text>,                /* ID сессии для сервисов GIS. */
  "au": <text>,                     /* Имя пользователя. */
  "tm": <uint>,                     /* Текущее время (UTC). */
  "wsdk_version": <text>,           /* Версия SDK. */
  "base_url": <text>,               /* URL сервера Wialon SDK (пустая строка, если не задан). */
  "hw_gw_ip": <text>,               /* IP-адрес сервера, на который устройства отправляют данные. */
  "hw_gw_dns": <text>,              /* Доменное имя сервера, на который устройства отправляют данные. */
  "gis_search": <text>,             /* URL сервиса поиска GIS. */
  "gis_render": <text>,             /* URL сервиса рендеринга GIS. */
  "gis_geocode": <text>,            /* URL сервиса геокодирования GIS. */
  "gis_routing": <text>,            /* URL сервиса маршрутизации GIS. */
  "billing_by_codes": <text>,       /* Коды активации: "1", если включены, "0", если нет. */
  "drivers_feature_flags": <text>,  /* Флаги функций водителей для учетной записи. */
  "feature_flags": <text>,          /* Флаги функций учетной записи в формате JSON (только если заданы). */

  "user": {                         /* Пользователь, от имени которого выполняется вход. Возвращается с флагом 0x2. */
    "nm": <text>,         /* Имя. */
    "cls": <uint>,        /* ID суперкласса «пользователь». */
    "id": <long>,         /* ID. */
    "prp": {              /* Произвольные свойства (возвращаются с флагом 0x20), например: */
      "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>     /* Ограничения на мобильные приложения, указанные в тарифном плане. */
  },

  "token": "{\"app\":\"<text>\",\"ct\":<uint>,\"at\":<uint>,\"dur\":<uint>,\"fl\":<uint>,\"p\":\"<text>\",\"items\":[<long>]}",
                                    /* Все настройки токена в виде экранированного JSON. Возвращается с флагом 0x4. */
  "th": <text>,                     /* Имя токена, совпадает с параметром token запроса. Возвращается с флагом 0x4. */

  "classes": {                      /* Суперклассы, доступные текущему пользователю (ключ: имя суперкласса, значение: ID суперкласса). Возвращается с флагом 0x8. */
    "avl_hw": <uint>,            /* Тип оборудования. */
    "avl_resource": <uint>,      /* Ресурс. */
    "avl_retranslator": <uint>,  /* Ретранслятор. */
    "avl_unit": <uint>,          /* Объект. */
    "avl_unit_group": <uint>,    /* Группа объектов. */
    "user": <uint>,              /* Пользователь. */
    "user_group": <uint>,        /* Группа пользователей. */
    "avl_route": <uint>          /* Маршрут. */
  },

  "web_site": <text>,               /* URL системы мониторинга Wialon. Возвращается с флагом 0x40. */
  "web_cms_manager_site": <text>,   /* URL системы управления Wialon. Возвращается с флагом 0x40. */

  "features": {                     /* Возвращается с флагом 0x10. */
    "unlim": <bool>,  /* Тип тарифного плана: 0 (обычный) или 1 (специальный, для разработки и тестирования). */
    "svcs": {         /* Хеш-коллекция разрешенных сервисов. Если сервис здесь не упомянут, значит, он запрещен. */
      "<service_name>": <bool>,  /* Ключ: имя сервиса. Значение: 0 (сервис доступен, но достигнут лимит) или 1 (сервис доступен и может использоваться). */
      ...
    }
  },

  "video_service_url": <text>       /* URL видеосервиса (только если включена услуга видеомониторинга). */
}

В Wialon Local параметры drivers_feature_flags и feature_flags доступны начиная с версии 2604. Параметры billing_by_codes и video_service_url в Wialon Local недоступны.

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

Коды ошибок

Код ошибки Описание
4 Неверная длина токена.
6 Неизвестная ошибка.
7 Пользователь отключен, не достигнуто время активации токена или нет доступа к услуге.
8 Указанный подчиненный пользователь не найден или у вас нет прав доступа к этому пользователю.
1003 Превышен лимит запросов.

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