Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.krainovim - Content
-
... ... @@ -60,9 +60,6 @@ 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 - 66 66 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 67 67 68 68 (% class="box infomessage" %) ... ... @@ -176,6 +176,7 @@ 176 176 { 177 177 "agentId": "",(% style="color:#000000" %) (%%) 178 178 "parentId": "", 176 + "parentName": "string", 179 179 "name": "string", 180 180 "fullName": "string", 181 181 "agentInfoType": 0, ... ... @@ -186,6 +186,7 @@ 186 186 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 187 187 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 188 188 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 187 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 189 189 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 190 190 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 191 191 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) ... ... @@ -372,7 +372,7 @@ 372 372 373 373 Ответ: Code 204 374 374 375 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 374 +== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) == 376 376 377 377 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 378 378 ... ... @@ -1805,7 +1805,7 @@ 1805 1805 1806 1806 (% style="color:#000000" %)Метод запроса: **GET** 1807 1807 1808 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 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]] 1809 1809 1810 1810 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1811 1811 ... ... @@ -1888,56 +1888,6 @@ 1888 1888 } 1889 1889 ] 1890 1890 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 - 1941 1941 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1942 1942 1943 1943 (% class="box infomessage" %) ... ... @@ -1962,11 +1962,6 @@ 1962 1962 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1963 1963 } 1964 1964 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 - 1970 1970 Ответ: 1971 1971 1972 1972 [ ... ... @@ -1973,43 +1973,25 @@ 1973 1973 { 1974 1974 "messages": [ 1975 1975 { 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": { 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": { ~/~/ список параметров датчиков передаваемых терминалом 1986 1986 "additionalProp1": "string", 1987 1987 "additionalProp2": "string", 1988 1988 "additionalProp3": "string" 1989 1989 }, 1990 - "photoCount": 0, 1991 - "lbsCorrectedCoords": true, 1992 - "protocolType": 0 1933 + "photoCount": 0 ~/~/ Кол-во фото 1993 1993 } 1994 1994 ] 1995 1995 } 1996 1996 ] 1997 1997 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 - 2013 2013 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2014 2014 2015 2015 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2143,129 +2143,6 @@ 2143 2143 } 2144 2144 ] 2145 2145 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 - 2269 2269 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2270 2270 2271 2271 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3942,7 +3942,7 @@ 3942 3942 3943 3943 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3944 3944 3945 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтин га качества вождения**(%%) ==3748 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) == 3946 3946 3947 3947 (% class="box infomessage" %) 3948 3948 ((( ... ... @@ -4048,152 +4048,6 @@ 4048 4048 |driverName|Имя водителя 4049 4049 |driverRfid|Номер Карты-метки 4050 4050 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 -Запрос должен содержать параметры: 4063 - 4064 -{ 4065 - 4066 - "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения 4067 - 4068 - "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения 4069 - 4070 - "ids": [ 4071 - 4072 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт 4073 - 4074 - ], 4075 - 4076 - "timezone": 0, ~/~/ Часовой пояс 4077 - 4078 - "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца 4079 - 4080 -} 4081 - 4082 -Ответ: 4083 - 4084 - { 4085 - 4086 - "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции 4087 - 4088 - " driver ": "string", ~/~/ Имя водителя 4089 - 4090 - "amount": 0, ~/~/ Количество топлива 4091 - 4092 - "amountDut": 0, ~/~/ Количество топлива по ДУТ 4093 - 4094 - "amountDiff": 0, ~/~/ Разница в литрах 4095 - 4096 - "amountDiffPerc": 0, ~/~/ Разница в % 4097 - 4098 - "summa": 0, ~/~/ Стоимость в руб. 4099 - 4100 - "serviceName": "string", ~/~/ Тип топлива 4101 - 4102 - "price": 0, ~/~/ Цена за литр в руб. 4103 - 4104 - "cardName": "string", ~/~/ Наименование ТК 4105 - 4106 - "cardNum": "string", ~/~/ Номер ТК 4107 - 4108 - "operator": "string", ~/~/ Оператор ТК 4109 - 4110 - "address": "string", ~/~/ Адрес АЗС 4111 - 4112 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid топливной карты 4113 - 4114 - } 4115 - 4116 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4117 - 4118 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4119 - 4120 - 4121 -(% class="box infomessage" %) 4122 -((( 4123 -GET api/v3/Vehicles/recyclebin/all 4124 -))) 4125 - 4126 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4127 - 4128 -Параметр запроса: {parentId} - идентификатор агента 4129 - 4130 -В заголовках запроса: X-Auth: Токен авторизации 4131 - 4132 -Ответ: 4133 - 4134 -"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC 4135 -"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект 4136 -"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента 4137 -"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта 4138 -"objectType": "Vehicle", - Тип объекта 4139 -"details": { 4140 -"items": [ { 4141 -"name": "ObjectName", - наименование столбца 4142 -"value": "01" - содержание столбца 4143 -}, 4144 - 4145 -{ 4146 -"parentName": "string", 4147 -"name": "string", 4148 -"picture": "string", 4149 -"minspeed": 0, 4150 -"maxspeed": 0, 4151 -"width": 0, 4152 -"imbeddedtrailer": true, 4153 -"hoppercapacity": 0, 4154 -"hopperdischargespeed": 0, 4155 -"modelType": 0, 4156 -"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4157 -"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4158 -"deleted": true 4159 -} 4160 - 4161 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4162 - 4163 -(% class="box infomessage" %) 4164 -((( 4165 -POST/api/v3/Vehicles/recyclebin/erase 4166 -))) 4167 - 4168 -В заголовках запроса: X-Auth: Токен авторизации 4169 - 4170 -Параметры в теле запроса (JSON): 4171 -[ 4172 -"eb737fdf-c422-4df7-8727-bd61439b8460", 4173 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4174 -] 4175 - 4176 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4177 - 4178 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4179 - 4180 -(% class="box infomessage" %) 4181 -((( 4182 -POST/api/v3/Vehicles/recyclebin/restore 4183 -))) 4184 - 4185 -В заголовках запроса: X-Auth: Токен авторизации 4186 - 4187 -Параметры в теле запроса (JSON): 4188 -[ 4189 -"eb737fdf-c422-4df7-8727-bd61439b8460", 4190 -"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3" 4191 -] 4192 - 4193 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4194 - 4195 - 4196 - 4197 4197 (% class="box" lang="en-US" style="text-align: center;" %) 4198 4198 ((( 4199 4199 (% 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]] **