Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -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 - Договор) ... ... @@ -371,7 +371,7 @@ 371 371 372 372 Ответ: Code 204 373 373 374 -= =(% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) ==372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 375 375 376 376 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 377 377 ... ... @@ -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]]1805 +(% 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 1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1889 + 1890 +(% class="box infomessage" style="text-align: left;" %) 1891 +((( 1892 +**POST /api/v3/terminalMessages/mapping** 1893 +))) 1894 + 1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1896 + 1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1898 + 1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1900 + 1901 +{ 1902 + "protocolType": 0, 1903 + "params": ["string"] 1904 +} 1905 + 1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1907 +|protocolType|ID типа протокола 1908 +|params|((( 1909 +Массив наименований параметров в сообщении 1910 +))) 1911 + 1912 +Ответ: 1913 + 1914 +{ 1915 + "protocolType": 0, 1916 + "mapping": { 1917 + "additionalProp1": { 1918 + "inputType": 0, 1919 + "inputNumber": 0 1920 + }, 1921 + "additionalProp2": { 1922 + "inputType": 0, 1923 + "inputNumber": 0 1924 + } 1925 + } 1926 +} 1927 + 1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1929 +|protocolType|Тип протокола 1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1931 +|inputNumber|((( 1932 +Номер входа 1933 +))) 1934 + 1935 +(% class="wikigeneratedid" %) 1936 +Перечень 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/]] 1937 + 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 1962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1963 +|vehicleId|ID объекта 1964 +|from|Дата и время начала периода запроса 1965 +|to|Дата и время окончания периода запроса 1966 + 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": { ~/~/ список параметров датчиков передаваемых терминалом 1973 + "deviceTime": "2023-11-29T07:40:44.052Z", 1974 + "serverTime": "2023-11-29T07:40:44.052Z", 1975 + "speed": 0, 1976 + "altitude": 0, 1977 + "latitude": 0, 1978 + "longitude": 0, 1979 + "satellites": 0, 1980 + "course": 0, 1981 + "voltage": 0, 1982 + "parameters": { 1929 1929 "additionalProp1": "string", 1930 1930 "additionalProp2": "string", 1931 1931 "additionalProp3": "string" 1932 1932 }, 1933 - "photoCount": 0 ~/~/ Кол-во фото 1987 + "photoCount": 0, 1988 + "lbsCorrectedCoords": true, 1989 + "protocolType": 0 1934 1934 } 1935 1935 ] 1936 1936 } 1937 1937 ] 1938 1938 1995 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1996 +|deviceTime|Время сообщения терминала 1997 +|serverTime|Время когда сообщение поступило на сервер 1998 +|speed|Скорость 1999 +|altitude|Высота над уровнем моря 2000 +|latitude|Широта 2001 +|longitude|Долгота 2002 +|satellites|Кол-во спутников 2003 +|course|Курс 2004 +|voltage|Бортовое напряжение 2005 +|parameters|Список параметров и их значений 2006 +|photoCount|Количество фото 2007 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2008 +|protocolType|ID типа протокола 2009 + 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 2143 + 2144 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2145 + 2146 +(% class="box infomessage" %) 2147 +((( 2148 +**POST /api/v3/vehicles/moveStop** 2149 +))) 2150 + 2151 +Метод запроса: **POST** 2152 + 2153 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2154 + 2155 +В заголовках запроса: X-Auth: Токен авторизации 2156 + 2157 + 2158 +Тело запроса: 2159 + 2160 +{ 2161 + 2162 + "vehicleIds": [ ], ~/~/ Список ID объектов 2163 + 2164 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2165 + 2166 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2167 + 2168 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2169 + 2170 +} 2171 + 2172 +Ответ: 2173 + 2174 +[ 2175 + 2176 + { 2177 + 2178 + "vehicleId": 0, ~/~/ ID объекта 2179 + 2180 + "vehicleName": "string", ~/~/ Имя объекта 2181 + 2182 + "moves": [ ~/~/ Событие движения 2183 + 2184 + { 2185 + 2186 + "mileage": 0, ~/~/ Пробег, км 2187 + 2188 + "eventId": 0, ~/~/ Идентификатор события 2189 + 2190 + "eventName": "string", ~/~/ Название события 2191 + 2192 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2193 + 2194 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2195 + 2196 + "duration": 0 ~/~/ Продолжительность события, секунд 2197 + 2198 + } 2199 + 2200 + ], 2201 + 2202 + "stops": [ ~/~/ События стоянок 2203 + 2204 + { 2205 + 2206 + "address": "string", ~/~/ Адрес события 2207 + 2208 + "eventId": 0, ~/~/ Идентификатор события 2209 + 2210 + "eventName": "string", ~/~/ Название события 2211 + 2212 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2213 + 2214 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2215 + 2216 + "duration": 0 ~/~/ Продолжительность события, секунд 2217 + 2218 + 2219 + } 2220 + 2221 + ] 2222 + 2223 + } 2224 + 2225 +] 2226 + 2227 + 2228 + 2229 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2230 + 2231 +(% class="box infomessage" %) 2232 +((( 2233 +**POST /api/v3/vehicles/getlastdata** 2234 +))) 2235 + 2236 +Метод запроса: **POST** 2237 + 2238 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2239 + 2240 +В заголовках запроса: X-Auth: Токен авторизации 2241 + 2242 + 2243 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2244 + 2245 +Ответ: 2246 + { 2247 + "vehicleId": 0, ~/~/Идентификатор объекта. 2248 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2249 + "vehicleNumber": "string",~/~/Номер объекта. 2250 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2251 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2252 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2253 + "speed": 0,~/~/Скорость объекта. 2254 + "course": 0,~/~/Курс движения [0;360] 2255 + "latitude": 0,~/~/Широта [-90°;90°]. 2256 + "longitude": 0,~/~/Долгота [-180°;180°]. 2257 + "address": "string",~/~/Адрес. 2258 + "geozones": [ ~/~/Сведения по геозонам. 2259 + { 2260 + "id": 0, 2261 + "name": "string" 2262 + } 2263 + 2264 + 2265 + 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" %)**Запрос рейтин ша качества вождения**(%%) ==3942 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3749 3749 3750 3750 (% class="box infomessage" %) 3751 3751 ((( ... ... @@ -3851,6 +3851,72 @@ 3851 3851 |driverName|Имя водителя 3852 3852 |driverRfid|Номер Карты-метки 3853 3853 4048 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4049 + 4050 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4051 + 4052 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК» 4053 + 4054 +(% class="box infomessage" %) 4055 +((( 4056 +**POST**/api/v3/fuelcards/transactions 4057 +))) 4058 + 4059 +Запрос должен содержать параметры: 4060 + 4061 +{ 4062 + 4063 + "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения 4064 + 4065 + "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения 4066 + 4067 + "ids": [ 4068 + 4069 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт 4070 + 4071 + ], 4072 + 4073 + "timezone": 0, ~/~/ Часовой пояс 4074 + 4075 + "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4076 + 4077 +} 4078 + 4079 +Ответ: 4080 + 4081 + { 4082 + 4083 + "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции 4084 + 4085 + " driver ": "string", ~/~/ Имя водителя 4086 + 4087 + "amount": 0, ~/~/ Количество топлива 4088 + 4089 + "amountDut": 0, ~/~/ Количество топлива по ДУТ 4090 + 4091 + "amountDiff": 0, ~/~/ Разница в литрах 4092 + 4093 + "amountDiffPerc": 0, ~/~/ Разница в % 4094 + 4095 + "summa": 0, ~/~/ Стоимость в руб. 4096 + 4097 + "serviceName": "string", ~/~/ Тип топлива 4098 + 4099 + "price": 0, ~/~/ Цена за литр в руб. 4100 + 4101 + "cardName": "string", ~/~/ Наименование ТК 4102 + 4103 + "cardNum": "string", ~/~/ Номер ТК 4104 + 4105 + "operator": "string", ~/~/ Оператор ТК 4106 + 4107 + "address": "string", ~/~/ Адрес АЗС 4108 + 4109 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid топливной карты 4110 + 4111 + } 4112 + 4113 + 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]] **