WebMap - Создание токенов — различия между версиями

Материал из TK
Перейти к: навигация, поиск
(Новая страница: «Через создание токенов можно предоставлять конечным пользователям уникальную ссылку д…»)
 
Строка 6: Строка 6:
 
* Удаление токена
  
* Удаление токена
   
−
Перед созданием токена необходима [[WebMap_API_Аутентификация]].
 +
Перед созданием токена необходима [[WebMap_API_Аутентификация|Аутентификация]].
  +
Все операции выполняются методом POST с заголовком Content-Type = "application/x-www-form-urlencoded" и кодировке UTF-8.
  +
  +
== Создание токена ==
  +
  +
URL: /Account/MakeToken
  +
<table class='parms' style='width:100%;'>
  +
<tr>
  +
<td>id</td>
  +
<td>- ID организации, в которой будет выполнятся поиск объектов нижеуказанных UIDов.</td>
  +
<td>Обязателен</td>
  +
</tr>
  +
<tr>
  +
<td>iduser</td>
  +
<td>- ID пользователя, на которого создается токен (таблица Users в БД)</td>
  +
<td>Обязателен</td>
  +
</tr>
  +
  +
<tr>
  +
<td>objID</td>
  +
<td>- GUID объекта или объектов (ТС), на которой создаются токены. Один или несколько GUIDов (через запятую). Может быть как GUID группы так и отдельных ТС, так и тех и других (таблицы CarGroup и Cars в БД, поле UID)</td>
  +
<td>Обязателен</td>
  +
</tr>
  +
  +
<tr>
  +
<td>objSubgroups</td>
  +
<td>- true, если включать в токен все подгруппы указанных в objID групп или false, если включатся только ТС в указанной группе.</td>
  +
<td>Если отсутствует - принимается как false</td>
  +
</tr>
  +
  +
<tr>
  +
<td>objTrack</td>
  +
<td>- true, если показывать трек за текущие сутки (по умолчанию) по всем доступным токену ТС или false, если только последнее местоположение</td>
  +
<td>Если отсутствует - принимается как false</td>
  +
</tr>
  +
  +
<tr>
  +
<td>geoFilterID</td>
  +
<td>- GUID геозон, которые используются для фильтрации. Позволяет ограничить просмотр трека - трек будет отображаться только в указанных геозонах, например если указана большая геозона очерченная вокруг города - трек ТС будет показываться только в городе и не будет показываться вне этой геозоны (таблица GeoObject или GeoObjectGroup, поле UID)</td>
  +
<td>Не обязателен</td>
  +
</tr>
  +
  +
<tr>
  +
<td>geoFilterSubgroups</td>
  +
<td>- true, если при фильтрации используется все вложенные подгруппы, а geoFilterID - GUID группы</td>
  +
<td>Если отсутствует - принимается как false</td>
  +
</tr>
  +
  +
<tr>
  +
<td>geoViewID</td>
  +
<td>- GUID геозон или групп геозон, которые будут показываться на карте</td>
  +
<td>Не обязателен</td>
  +
</tr>
  +
  +
<tr>
  +
<td>geoViewSubgroups</td>
  +
<td>- true, если для отображения используется все вложенные подгруппы, а geoFilterID - GUID группы</td>
  +
<td>Если отсутствует - принимается как false</td>
  +
</tr>
  +
  +
<tr>
  +
<td>SD</td>
  +
<td>- дата/время начала действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM</td>
  +
<td>Не обязательный параметр, если отсутствует - токен начинает действовать немедленно</td>
  +
</tr>
  +
<tr>
  +
<td>ED</td>
  +
<td>- дата/время окончания действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM</td>
  +
<td>Не обязательный параметр, если отсутствует - токен будет бессрочным</td>
  +
</tr>
  +
<tr>
  +
<td>VSD</td>
  +
<td>- начальные дата/время доступных токену данных по ТС, локальное время пользователя. Формат YYYYMMDD-HHMM</td>
  +
<td>Не обязательный параметр, если отсутствует - данные доступны за весь период</td>
  +
</tr>
  +
<tr>
  +
<td>VED</td>
  +
<td>- конечные дата/время доступных токену данных - локальное время пользователя. Формат YYYYMMDD-HHMM</td>
  +
<td>Не обязательный параметр, если отсутствует - данные доступны за весь период</td>
  +
</tr>
  +
</table>
  +
  +
Пример:
  +
  +
  +
  +
== Изменение параметров токена ==
  +
  +
== Удаление токена ==

Версия 17:39, 6 августа 2016

Через создание токенов можно предоставлять конечным пользователям уникальную ссылку для отслеживания транспортных средств в ограниченный период времени (например для слежения за грузами или доставкой).

Поддерживается следующие операции с токенами:

  • Создание токена
  • Изменение параметров токена (период действия, список доступных ТС, включение/отключение режима трека, ...)
  • Удаление токена

Перед созданием токена необходима Аутентификация. Все операции выполняются методом POST с заголовком Content-Type = "application/x-www-form-urlencoded" и кодировке UTF-8.

Создание токена

URL: /Account/MakeToken

id - ID организации, в которой будет выполнятся поиск объектов нижеуказанных UIDов. Обязателен
iduser - ID пользователя, на которого создается токен (таблица Users в БД) Обязателен
objID - GUID объекта или объектов (ТС), на которой создаются токены. Один или несколько GUIDов (через запятую). Может быть как GUID группы так и отдельных ТС, так и тех и других (таблицы CarGroup и Cars в БД, поле UID) Обязателен
objSubgroups - true, если включать в токен все подгруппы указанных в objID групп или false, если включатся только ТС в указанной группе. Если отсутствует - принимается как false
objTrack - true, если показывать трек за текущие сутки (по умолчанию) по всем доступным токену ТС или false, если только последнее местоположение Если отсутствует - принимается как false
geoFilterID - GUID геозон, которые используются для фильтрации. Позволяет ограничить просмотр трека - трек будет отображаться только в указанных геозонах, например если указана большая геозона очерченная вокруг города - трек ТС будет показываться только в городе и не будет показываться вне этой геозоны (таблица GeoObject или GeoObjectGroup, поле UID) Не обязателен
geoFilterSubgroups - true, если при фильтрации используется все вложенные подгруппы, а geoFilterID - GUID группы Если отсутствует - принимается как false
geoViewID - GUID геозон или групп геозон, которые будут показываться на карте Не обязателен
geoViewSubgroups - true, если для отображения используется все вложенные подгруппы, а geoFilterID - GUID группы Если отсутствует - принимается как false
SD - дата/время начала действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM Не обязательный параметр, если отсутствует - токен начинает действовать немедленно
ED - дата/время окончания действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM Не обязательный параметр, если отсутствует - токен будет бессрочным
VSD - начальные дата/время доступных токену данных по ТС, локальное время пользователя. Формат YYYYMMDD-HHMM Не обязательный параметр, если отсутствует - данные доступны за весь период
VED - конечные дата/время доступных токену данных - локальное время пользователя. Формат YYYYMMDD-HHMM Не обязательный параметр, если отсутствует - данные доступны за весь период

Пример:


Изменение параметров токена

Удаление токена

Источник — «http://oldwiki.tk-chel.ru/index.php?title=WebMap_-_Создание_токенов&oldid=56420»