Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 125.2 >
edited by Илья Крайнов
on 2023/11/28 16:07
To version < 154.1 >
edited by Андрей Калиновский
on 2024/04/11 14:20
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -60,6 +60,9 @@
60 60  |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 61  |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 62  
63 +(% class="wikigeneratedid" %)
64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
65 +
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -173,7 +173,6 @@
173 173  {
174 174   "agentId": "",(% style="color:#000000" %)   (%%)
175 175   "parentId": "",
176 - "parentName": "string",
177 177   "name": "string",
178 178   "fullName": "string",
179 179   "agentInfoType": 0,
... ... @@ -184,7 +184,6 @@
184 184  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
185 185  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
186 186  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
188 188  |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
189 189  |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
190 190  |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
... ... @@ -1430,7 +1430,7 @@
1430 1430  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1431 1431  )))
1432 1432  
1433 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1434 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1434 1434  
1435 1435  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1436 1436  
... ... @@ -1804,7 +1804,7 @@
1804 1804  
1805 1805  (% style="color:#000000" %)Метод запроса: **GET**
1806 1806  
1807 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1808 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1808 1808  
1809 1809  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1810 1810  
... ... @@ -1887,6 +1887,56 @@
1887 1887   }
1888 1888  ]
1889 1889  
1891 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1892 +
1893 +(% class="box infomessage" style="text-align: left;" %)
1894 +(((
1895 +**POST /api/v3/terminalMessages/mapping**
1896 +)))
1897 +
1898 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1899 +
1900 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1901 +
1902 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1903 +
1904 +{
1905 + "protocolType": 0,
1906 + "params": ["string"]
1907 +}
1908 +
1909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1910 +|protocolType|ID типа протокола
1911 +|params|(((
1912 +Массив наименований параметров в сообщении
1913 +)))
1914 +
1915 +Ответ:
1916 +
1917 +{
1918 + "protocolType": 0,
1919 + "mapping": {
1920 + "additionalProp1": {
1921 + "inputType": 0,
1922 + "inputNumber": 0
1923 + },
1924 + "additionalProp2": {
1925 + "inputType": 0,
1926 + "inputNumber": 0
1927 + }
1928 + }
1929 +}
1930 +
1931 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1932 +|protocolType|Тип протокола
1933 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1934 +|inputNumber|(((
1935 +Номер входа
1936 +)))
1937 +
1938 +(% class="wikigeneratedid" %)
1939 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
1940 +
1890 1890  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1891 1891  
1892 1892  (% class="box infomessage" %)
... ... @@ -1911,6 +1911,11 @@
1911 1911   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1912 1912  }
1913 1913  
1965 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1966 +|vehicleId|ID объекта
1967 +|from|Дата и время начала периода запроса
1968 +|to|Дата и время окончания периода запроса
1969 +
1914 1914  Ответ:
1915 1915  
1916 1916  [
... ... @@ -1917,25 +1917,43 @@
1917 1917   {
1918 1918   "messages": [
1919 1919   {
1920 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1921 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1922 - "speed": 0, ~/~/ Скорость, км/ч
1923 - "altitude": 0, ~/~/ Высота, м
1924 - "latitude": 0, ~/~/ Широта [-90°;90°]
1925 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1926 - "satellites": 0, ~/~/ Кол-во спутников
1927 - "voltage": 0, ~/~/ Напряжение
1928 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1976 + "deviceTime": "2023-11-29T07:40:44.052Z",
1977 + "serverTime": "2023-11-29T07:40:44.052Z",
1978 + "speed": 0,
1979 + "altitude": 0,
1980 + "latitude": 0,
1981 + "longitude": 0,
1982 + "satellites": 0,
1983 + "course": 0,
1984 + "voltage": 0,
1985 + "parameters": {
1929 1929   "additionalProp1": "string",
1930 1930   "additionalProp2": "string",
1931 1931   "additionalProp3": "string"
1932 1932   },
1933 - "photoCount": 0 ~/~/ Кол-во фото
1990 + "photoCount": 0,
1991 + "lbsCorrectedCoords": true,
1992 + "protocolType": 0
1934 1934   }
1935 1935   ]
1936 1936   }
1937 1937  ]
1938 1938  
1998 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1999 +|deviceTime|Время сообщения терминала
2000 +|serverTime|Время когда сообщение поступило на сервер
2001 +|speed|Скорость
2002 +|altitude|Высота над уровнем моря
2003 +|latitude|Широта
2004 +|longitude|Долгота
2005 +|satellites|Кол-во спутников
2006 +|course|Курс
2007 +|voltage|Бортовое напряжение
2008 +|parameters|Список параметров и их значений
2009 +|photoCount|Количество фото
2010 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2011 +|protocolType|ID типа протокола
2012 +
1939 1939  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1940 1940  
1941 1941  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2069,6 +2069,129 @@
2069 2069   }
2070 2070  ]
2071 2071  
2146 +
2147 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2148 +
2149 +(% class="box infomessage" %)
2150 +(((
2151 +**POST /api/v3/vehicles/moveStop**
2152 +)))
2153 +
2154 +Метод запроса: **POST**
2155 +
2156 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2157 +
2158 +В заголовках запроса: X-Auth: Токен авторизации
2159 +
2160 +
2161 +Тело запроса:
2162 +
2163 +{
2164 +
2165 + "vehicleIds": [ ], ~/~/ Список ID объектов
2166 +
2167 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2168 +
2169 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2170 +
2171 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2172 +
2173 +}
2174 +
2175 +Ответ:
2176 +
2177 +[
2178 +
2179 + {
2180 +
2181 + "vehicleId": 0, ~/~/ ID объекта
2182 +
2183 + "vehicleName": "string", ~/~/ Имя объекта
2184 +
2185 + "moves": [ ~/~/ Событие движения
2186 +
2187 + {
2188 +
2189 + "mileage": 0, ~/~/ Пробег, км
2190 +
2191 + "eventId": 0, ~/~/ Идентификатор события
2192 +
2193 + "eventName": "string", ~/~/ Название события
2194 +
2195 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2196 +
2197 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2198 +
2199 + "duration": 0 ~/~/ Продолжительность события, секунд
2200 +
2201 + }
2202 +
2203 + ],
2204 +
2205 + "stops": [ ~/~/ События стоянок
2206 +
2207 + {
2208 +
2209 + "address": "string", ~/~/ Адрес события
2210 +
2211 + "eventId": 0, ~/~/ Идентификатор события
2212 +
2213 + "eventName": "string", ~/~/ Название события
2214 +
2215 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2216 +
2217 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2218 +
2219 + "duration": 0 ~/~/ Продолжительность события, секунд
2220 +
2221 +
2222 + }
2223 +
2224 + ]
2225 +
2226 + }
2227 +
2228 +]
2229 +
2230 +
2231 +
2232 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2233 +
2234 +(% class="box infomessage" %)
2235 +(((
2236 +**POST /api/v3/vehicles/getlastdata**
2237 +)))
2238 +
2239 +Метод запроса: **POST**
2240 +
2241 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2242 +
2243 +В заголовках запроса: X-Auth: Токен авторизации
2244 +
2245 +
2246 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2247 +
2248 +Ответ:
2249 + {
2250 + "vehicleId": 0, ~/~/Идентификатор объекта.
2251 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2252 + "vehicleNumber": "string",~/~/Номер объекта.
2253 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2254 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2255 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2256 + "speed": 0,~/~/Скорость объекта.
2257 + "course": 0,~/~/Курс движения [0;360]
2258 + "latitude": 0,~/~/Широта [-90°;90°].
2259 + "longitude": 0,~/~/Долгота [-180°;180°].
2260 + "address": "string",~/~/Адрес.
2261 + "geozones": [ ~/~/Сведения по геозонам.
2262 + {
2263 + "id": 0,
2264 + "name": "string"
2265 + }
2266 +
2267 +
2268 +
2072 2072  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2073 2073  
2074 2074  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3745,7 +3745,7 @@
3745 3745  
3746 3746  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3747 3747  
3748 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3945 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3749 3749  
3750 3750  (% class="box infomessage" %)
3751 3751  (((
... ... @@ -3851,6 +3851,155 @@
3851 3851  |driverName|Имя водителя
3852 3852  |driverRfid|Номер Карты-метки
3853 3853  
4051 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4052 +
4053 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4054 +
4055 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4056 +
4057 +(% class="box infomessage" %)
4058 +(((
4059 +POST /api/v3/fuelcards/transactions
4060 +)))
4061 +
4062 +Метод запроса: POST
4063 +
4064 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4065 +\\В заголовках запроса: X-Auth: Токен авторизации
4066 +
4067 +Параметры в теле запроса (JSON):
4068 +
4069 +{
4070 +
4071 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4072 +
4073 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4074 +
4075 + "ids": [
4076 +
4077 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4078 +
4079 + ],
4080 +
4081 + "timezone": 0 ~/~/Таймзона
4082 +
4083 +}
4084 +
4085 +Ответ:
4086 +
4087 + {
4088 +
4089 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4090 +
4091 + "driver": "string", ~/~/Водители, привязанные к ТК
4092 +
4093 + "object": "string", ~/~/Наименование ТС
4094 +
4095 + "amount": 0, ~/~/Количество топлива
4096 +
4097 + "amountDut": 0, ~/~/Количество по ДУТ
4098 +
4099 + "amountDiff": 0, ~/~/Разница, л
4100 +
4101 + "amountDiffPerc": 0, ~/~/Разница, %
4102 +
4103 + "summa": 0, ~/~/Стоимость, руб
4104 +
4105 + "serviceName": "string", ~/~/Тип топлива
4106 +
4107 + "price": 0, ~/~/Цена за литр, руб
4108 +
4109 + "cardName": "string", ~/~/Наименование ТК
4110 +
4111 + "cardNum": "string", ~/~/Номер ТК
4112 +
4113 + "operator": "string", ~/~/Оператор ТК
4114 +
4115 + "address": "string" ~/~/Адрес АЗС
4116 +
4117 + }
4118 +
4119 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4120 +
4121 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4122 +
4123 +
4124 +(% class="box infomessage" %)
4125 +(((
4126 +GET api/v3/Vehicles/recyclebin/all
4127 +)))
4128 +
4129 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4130 +
4131 +Параметр запроса: {parentId} - идентификатор агента
4132 +
4133 +В заголовках запроса: X-Auth: Токен авторизации
4134 +
4135 +Ответ:
4136 +
4137 +"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
4138 +"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
4139 +"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
4140 +"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
4141 +"objectType": "Vehicle", - Тип объекта
4142 +"details": {
4143 +"items": [ {
4144 +"name": "ObjectName", - наименование столбца
4145 +"value": "01" - содержание столбца
4146 +},
4147 +
4148 +{
4149 +"parentName": "string",
4150 +"name": "string",
4151 +"picture": "string",
4152 +"minspeed": 0,
4153 +"maxspeed": 0,
4154 +"width": 0,
4155 +"imbeddedtrailer": true,
4156 +"hoppercapacity": 0,
4157 +"hopperdischargespeed": 0,
4158 +"modelType": 0,
4159 +"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4160 +"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4161 +"deleted": true
4162 +}
4163 +
4164 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4165 +
4166 +(% class="box infomessage" %)
4167 +(((
4168 +POST/api/v3/Vehicles/recyclebin/erase
4169 +)))
4170 +
4171 +В заголовках запроса: X-Auth: Токен авторизации
4172 +
4173 +Параметры в теле запроса (JSON):
4174 +[
4175 +"eb737fdf-c422-4df7-8727-bd61439b8460",
4176 +"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4177 +]
4178 +
4179 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4180 +
4181 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4182 +
4183 +(% class="box infomessage" %)
4184 +(((
4185 +POST/api/v3/Vehicles/recyclebin/restore
4186 +)))
4187 +
4188 +В заголовках запроса: X-Auth: Токен авторизации
4189 +
4190 +Параметры в теле запроса (JSON):
4191 +[
4192 +"eb737fdf-c422-4df7-8727-bd61439b8460",
4193 +"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
4194 +]
4195 +
4196 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4197 +
4198 +
4199 +
3854 3854  (% class="box" lang="en-US" style="text-align: center;" %)
3855 3855  (((
3856 3856  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

ГЛОНАССSoft wiki - 2024 г.