Интеграция с сайтами — различия между версиями

Материал из TK
Перейти к: навигация, поиск
(Описание параметров)
 
(не показано 12 промежуточных версий этого же участника)
Строка 1: Строка 1:
Интеграция со сторонними сайтами для отображения местоположения машин организации заключается в добавлении на страницу сайта объекта iframe со ссылкой вида
+
Интеграция со сторонними сайтами для отображения местоположения машин организации заключается в добавлении на страницу сайта объекта iframe со заранее сформированной ссылкой с токеном.
 
<iframe
 
 
код&nbsp;<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">5776C670CBBD2FE10677845A1A7D7583 называется токеном. Также Вы можете указать ряд параметров, которые с примерами рассмотрены ниже.</span>
 
 
<div>
 
<div>
 
== Создание токена ==
 
== Создание токена ==
   
{| border="0" cellspacing="0" cellpadding="0" style="width: 100%;"
+
{| border="0" cellspacing="0" cellpadding="5" style="width: 100%;"
 
|-
 
|-
| http://wiki.tk-chel.ru/images/2/29/Token.png<br/>
+
| style="vertical-align: top;" | http://wiki.tk-chel.ru/images/2/29/Token.png<br/>
 
| style="vertical-align: top;" |
 
| style="vertical-align: top;" |
 
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">Для доступа к сайту (и использования iframe) без ввода логина и пароля необходимо создать токен. Он создается в разделе /Install веб-интерфейса. В токене зашифрован логин, пароль и другая информация,&nbsp;</span>
 
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">Для доступа к сайту (и использования iframe) без ввода логина и пароля необходимо создать токен. Он создается в разделе /Install веб-интерфейса. В токене зашифрован логин, пароль и другая информация,&nbsp;</span>
Строка 17: Строка 13:
 
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">В окне создания токена&nbsp;'''Login&nbsp;'''и&nbsp;'''Password&nbsp;'''- это логин и пароль пользователя с ограниченными правами (как правило это пользователь "только для чтения").</span>
 
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">В окне создания токена&nbsp;'''Login&nbsp;'''и&nbsp;'''Password&nbsp;'''- это логин и пароль пользователя с ограниченными правами (как правило это пользователь "только для чтения").</span>
   
  +
|-
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">'''UTC-offset'''&nbsp;- смещение времени от UTC (в настоящее время этот параметр в большинстве браузеров и операционных систем заполняется автоматически при открытии страницы веб-интерфейса.</span>
 
  +
| style="vertical-align: top;" colspan="2" |
  +
{| border="1" cellpadding="5" cellspacing="0" style="width: 100%;"
  +
|-
  +
| style="width: 113px;" | <span style="line-height: 20.7999992370605px;">UTC-Offset</span><br/>
  +
| style="width: 948px;" | <span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">смещение времени от UTC (в настоящее время этот параметр в большинстве браузеров и операционных систем заполняется автоматически при открытии страницы веб-интерфейса</span><br/>
  +
|-
  +
| style="width: 113px;" | Car group path
  +
| style="width: 948px;" | путь к группе ТС, которые будут отображаться на карте в виде '''/Demo/My cars/Public''' (путь к группе Public должен задаваться от корня) - в этом случае будут отображены все ТС, которые находятся в группе Public. <span style="line-height: 20.7999992370605px;">Необязательный параметр, если отсутствует - будут отображаться все ТС, которые доступны токену.</span>&nbsp;
  +
|-
  +
| style="width: 113px;" | Geofence group for filtering
  +
| style="width: 948px;" | путь к группе геозон, которые будут использоваться для фильтрации ТС. Те ТС, последнее местоположение которых не попадает в геозоны из этой группы - на карте отображаться не будут.
  +
|-
  +
| style="width: 113px;" | Geofence group for showing
  +
| style="width: 948px;" | путь к группе геозон, которые будут отображаться на карте. Необязательный параметр, если отсутствует - геозоны на карте не показываются.
  +
|-
  +
| style="width: 113px;" | Activity period
  +
| style="width: 948px;" |
  +
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">срок действия токена. Необязательные параметры, если отсутствуеи - токен будет бессрочный.<br/>Также можно указывать одно из значений, тогджа токен будет действовать либо ДО либо ПОСЛЕ указанной даты-времени</span>
   
  +
|}
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">'''Activity period'''&nbsp;- срок действия токена. Можно не указывать, тогда токен будет бессрочный. Также можно указывать одно из значений, тогджа токен будет действовать либо ДО либо ПОСЛЕ указанной даты-времени.</span>
 
   
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">После нажатия на кнопку&nbsp;'''Create token'''&nbsp;будет создан и показан&nbsp;токен. Далее будет использован бессрочный&nbsp;токен&nbsp;</span>5776C670CBBD2FE10677845A1A7D7583 полученный для логина-пароля demo/demo.
+
<span style="color: rgb(0, 18, 32); font-family: Tahoma, Verdana; font-size: 13.3333330154419px; line-height: normal;">После нажатия на кнопку&nbsp;'''Create token'''&nbsp;будет создан и показан&nbsp;токен. Далее будет использован бессрочный&nbsp;токен&nbsp;</span><span style="line-height: 20.7999992370605px;">5776C670CBBD2FE10677845A1A7D7583 полученный для логина-пароля demo/demo.</span>
   
 
|}
 
|}
   
  +
== Описание параметров ==
   
  +
{| border="1" cellspacing="0" cellpadding="5" style="width: 100%;"
  +
|-
  +
| rowspan="2" colspan="1" | '''Параметр'''<br/>
  +
| rowspan="2" colspan="1" | '''Назначение'''<br/>
  +
| style="text-align: center;" rowspan="1" colspan="2" | '''Используется в'''<br/>
  +
|-
  +
| style="text-align: center;" | '''1 (местоположение)'''
  +
| style="text-align: center;" | '''2 (треки)'''
  +
|-
  +
| map
  +
| тип карты ([[Файл web.config WebMap.NET|полный список карт в параметре MapsEnabled]])
  +
| style="text-align: center;" | <span style="line-height: 20.7999992370605px;">да (необязательный)</span><br/>
  +
| style="text-align: center;" | <span style="line-height: 20.7999992370605px;">да (необязательный)</span><br/>
  +
|-
  +
| serials
  +
| номера приборов, через запятую
  +
| style="text-align: center;" | <span style="line-height: 20.7999992370605px;">да (необязательный)</span><br/>
  +
| <br/>
  +
|-
  +
| sd
  +
| начало периода&nbsp;<span style="line-height: 20.7999992370605px;">в формате YYYYMMDD или YYYYMMDD-HHMM (дата-время местное)</span>
  +
| <br/>
  +
| style="text-align: center;" | да (необязательный)
  +
|-
  +
| ed
  +
| конец периода в формате YYYYMMDD или YYYYMMDD-HHMM (дата-время местное)
  +
| <br/>
  +
| <p style="text-align: center;"><span style="line-height: 20.7999992370605px;">да (необязательный)<br/>(если отсутствует -<br/>трек выводится за сутки параметра sd)</span>
  +
|-
  +
| idorg
  +
| необязательный параметр, содержит ID организации, в которой ищутся приборы с номерами serials
  +
| <br/>
  +
| style="text-align: center;" | да (необязательный)
  +
|-
  +
</p>
  +
|}
  +
  +
<p>Параметры sd и ed могут называться sdutc и edutc соответственно - тогда подразумевается, что дата-время передается в UTC.</p>
   
== Режим "местоположение всех доступных токену&nbsp;ТС" ==
+
== Режим "местоположение всех доступных токену&nbsp;ТС" (1) ==
   
 
{| border="0" cellspacing="0" cellpadding="0" style="width: 100%;"
 
{| border="0" cellspacing="0" cellpadding="0" style="width: 100%;"
 
|-
 
|-
 
|
 
|
<code><iframe src='</code>[http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm]<code>'&nbsp;width='600' height='600'>&lt;/iframe&gt;</code>
+
<pre><iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm' width='600' height='600'></iframe></pre>
   
 
Будут отображено последнее известное местоположение всех ТС, доступных токену.
 
Будут отображено последнее известное местоположение всех ТС, доступных токену.
Строка 45: Строка 98:
 
|-
 
|-
 
|
 
|
<code><font face="sans-serif, Arial, Verdana, Trebuchet MS"><iframe src='</font></code>[http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986 http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986]<code><font face="sans-serif, Arial, Verdana, Trebuchet MS">[http://m.tk-chel.ru/Strict/Index/5776C670CBBD2FE10677845A1A7D7583?serials=9999999,9999998' '] width='600' height='600'>&lt;/iframe&gt;</font></code>
+
<pre><iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986' width='600' height='600'></iframe></pre>
   
 
Будут отображено последнее известное местоположение ТС. Эти приборы также должны быть доступны токену. Если указан недоступный прибор или прибор, у которого нет данных&nbsp;- он не будет отображен на карте.
 
Будут отображено последнее известное местоположение ТС. Эти приборы также должны быть доступны токену. Если указан недоступный прибор или прибор, у которого нет данных&nbsp;- он не будет отображен на карте.
Строка 51: Строка 104:
 
На обзорной карте видно местоположение ТС, если увеличить карту - можно увидеть трек ТС за сегодня.&nbsp;Также возможно использование дополнительных параметров sd/ed:
 
На обзорной карте видно местоположение ТС, если увеличить карту - можно увидеть трек ТС за сегодня.&nbsp;Также возможно использование дополнительных параметров sd/ed:
   
<iframe src='[http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986&sd=20140320' http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&amp;serials=9999986&sd=20140320'] width='600' height='600'>&lt;/iframe&gt;
+
<pre><iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986&sd=20140320' width='600' height='600'></iframe>
  +
<iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986&sd=20140320&ed=20140321' width='600' height='600'></iframe></pre>
 
<iframe src='<span style="line-height: 20.7999992370605px;">[http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986&sd=20140320&ed=20140321 http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&amp;serials=9999986&sd=20140320&amp;ed=20140321]</span>' width='600' height='600'>&lt;/iframe&gt;
 
   
 
|-
 
|-
 
| [[File:Integrate 2.jpg]]<br/>
 
| [[File:Integrate 2.jpg]]<br/>
 
|}
 
|}
 
== Режим "местоположение ТС с фильтрацией по группе или геозонам" ==
 
 
<span style="font-family: monospace; line-height: 20.7999992370605px;">1. <iframe src='</span>http://demo.tk-nav.com/Strict/Filter/A6CB2007DD716D04B478C77AB929F1B8?map=osm&carPath=/DemoCEBIT/Couriers%20(AG%20Mobile)<span style="font-family: monospace; line-height: 20.7999992370605px;">' width='600' height='600'>&lt;/iframe&gt;<br/>В&nbsp;данном примере будут отображены все ТС из подгруппы Couriers группы Demo.</span>
 
 
<span style="font-family: monospace; line-height: 20.7999992370605px;">2. <iframe src='</span>[http://demo.tk-nav.com/Strict/Filter/A6CB2007DD716D04B478C77AB929F1B8?map=osm&geoPath=/DemoCEBIT/Chelyabinsk/Districts http://demo.tk-nav.com/Strict/Filter/A6CB2007DD716D04B478C77AB929F1B8?map=osm&amp;geoPath=/DemoCEBIT/Chelyabinsk/Districts]<span style="font-family: monospace; line-height: 20.7999992370605px;">' width='600' height='600'>&lt;/iframe&gt;<br/>В&nbsp;данном примере будут отображены все ТС, которые в данный момент находятся в геозонах, расположенных в подгруппе MyCities группы Demo.<br/><span class="marker">Обратите внимание! ТС, местоположение которых находится ВНЕ геозон - отображатся не будут.</span> Но как только эти ТС войдут в одну из геозон указанной группы - они отобразятся на карте.</span>
 
 
<span style="font-family: monospace; line-height: 20.7999992370605px;">Данные примеры (параметры carPath и geoPath) можно использовать совместно.</span> &lt;/div&gt;
 

Текущая версия на 13:21, 13 февраля 2018

Интеграция со сторонними сайтами для отображения местоположения машин организации заключается в добавлении на страницу сайта объекта iframe со заранее сформированной ссылкой с токеном.

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

Token.png

Для доступа к сайту (и использования iframe) без ввода логина и пароля необходимо создать токен. Он создается в разделе /Install веб-интерфейса. В токене зашифрован логин, пароль и другая информация, 

которая необходима для входа на сайт и получения информации о транспортных средствах без ввода логина и пароля.

В окне создания токена Login и Password - это логин и пароль пользователя с ограниченными правами (как правило это пользователь "только для чтения").

UTC-Offset
смещение времени от UTC (в настоящее время этот параметр в большинстве браузеров и операционных систем заполняется автоматически при открытии страницы веб-интерфейса
Car group path путь к группе ТС, которые будут отображаться на карте в виде /Demo/My cars/Public (путь к группе Public должен задаваться от корня) - в этом случае будут отображены все ТС, которые находятся в группе Public. Необязательный параметр, если отсутствует - будут отображаться все ТС, которые доступны токену. 
Geofence group for filtering путь к группе геозон, которые будут использоваться для фильтрации ТС. Те ТС, последнее местоположение которых не попадает в геозоны из этой группы - на карте отображаться не будут.
Geofence group for showing путь к группе геозон, которые будут отображаться на карте. Необязательный параметр, если отсутствует - геозоны на карте не показываются.
Activity period

срок действия токена. Необязательные параметры, если отсутствуеи - токен будет бессрочный.
Также можно указывать одно из значений, тогджа токен будет действовать либо ДО либо ПОСЛЕ указанной даты-времени

После нажатия на кнопку Create token будет создан и показан токен. Далее будет использован бессрочный токен 5776C670CBBD2FE10677845A1A7D7583 полученный для логина-пароля demo/demo.

Описание параметров

Параметр
Назначение
Используется в
1 (местоположение) 2 (треки)
map тип карты (полный список карт в параметре MapsEnabled) да (необязательный)
да (необязательный)
serials номера приборов, через запятую да (необязательный)

sd начало периода в формате YYYYMMDD или YYYYMMDD-HHMM (дата-время местное)
да (необязательный)
ed конец периода в формате YYYYMMDD или YYYYMMDD-HHMM (дата-время местное)

да (необязательный)
(если отсутствует -
трек выводится за сутки параметра sd)

idorg необязательный параметр, содержит ID организации, в которой ищутся приборы с номерами serials
да (необязательный)

Параметры sd и ed могут называться sdutc и edutc соответственно - тогда подразумевается, что дата-время передается в UTC.

Режим "местоположение всех доступных токену ТС" (1)

<iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm' width='600' height='600'></iframe>

Будут отображено последнее известное местоположение всех ТС, доступных токену.

Integrate_1.jpg

Режим "треки указанных ТС за период" (2)

<iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986' width='600' height='600'></iframe>

Будут отображено последнее известное местоположение ТС. Эти приборы также должны быть доступны токену. Если указан недоступный прибор или прибор, у которого нет данных - он не будет отображен на карте.

На обзорной карте видно местоположение ТС, если увеличить карту - можно увидеть трек ТС за сегодня. Также возможно использование дополнительных параметров sd/ed:

<iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986&sd=20140320' width='600' height='600'></iframe>
<iframe src='http://demo.tk-nav.com/Strict/Index/A6CB2007DD716D04B478C77AB929F1B8?map=osm&serials=9999986&sd=20140320&ed=20140321' width='600' height='600'></iframe>
Integrate 2.jpg