Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 58.1 >
edited by Илья Крайнов
on 2022/11/24 11:29
To version < 38.1 >
edited by Илья Крайнов
on 2022/11/17 14:49
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,12 +1,13 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 +== ==
4 4  
5 -{{toc/}}
6 +(% class="box" style="text-align: center;" %)
7 +(((
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 +)))
6 6  
7 -
8 -=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
9 -
10 10  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 12  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
... ... @@ -14,15 +14,17 @@
14 14  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 15  
16 16  
17 -==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
18 18  
19 -
20 20  (% class="box successmessage" %)
21 21  (((
22 22   (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
23 23  )))
24 24  
25 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
26 26  
27 27  (% style="color:#000000" %)Метод запроса: **POST**
28 28  
... ... @@ -108,148 +108,6 @@
108 108  }
109 109  
110 110  
111 -(% class="box successmessage" %)
112 -(((
113 -**Добавление клиента — POST /api/v3/agents **
114 -)))
115 -
116 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
117 -
118 -Метод запроса: **POST**
119 -
120 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
121 -
122 -В заголовках запроса: X-Auth: Токен авторизации
123 -
124 -Параметры в теле запроса (JSON):
125 -
126 -{
127 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
128 - "name": "string", ~/~/ имя
129 - "fullName": "string", ~/~/ полное наименование
130 - "isForeign": true, ~/~/ иностранный контрагент
131 - "district": "string", ~/~/ округ
132 - "region": "string", ~/~/ регион
133 - "city": "string", ~/~/ город
134 - "inn": "string", ~/~/ ИНН
135 - "kpp": "string", ~/~/ КПП
136 - "address": "string", ~/~/ юридический адрес
137 - "addressFact": "string", ~/~/ фактический адрес
138 - "email": "string", ~/~/ email
139 - "director": "string", ~/~/ ФИО руководителя
140 - "bankName": "string", ~/~/ банк
141 - "bankBIK": "string", ~/~/ БИК
142 - "bankRS": "string", ~/~/ номер счёта
143 - "bankKS": "string" ~/~/ корр. счёт
144 -}
145 -
146 -
147 -Ответ:
148 -
149 -{
150 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
151 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
152 - "name": "string", ~/~/ имя
153 - "fullName": "string", ~/~/ полное наименование
154 - "isForeign": true, ~/~/ иностранный контрагент
155 - "district": "string", ~/~/ округ
156 - "region": "string", ~/~/ регион
157 - "city": "string", ~/~/ город
158 - "inn": "string", ~/~/ ИНН
159 - "kpp": "string", ~/~/ КПП
160 - "address": "string", ~/~/ юридический адрес
161 - "addressFact": "string", ~/~/ фактический адрес
162 - "email": "string", ~/~/ email
163 - "director": "string", ~/~/ ФИО руководителя
164 - "bankName": "string", ~/~/ банк
165 - "bankBIK": "string", ~/~/ БИК
166 - "bankRS": "string", ~/~/ номер счёта
167 - "bankKS": "string" ~/~/ корр. счёт
168 -}
169 -
170 -
171 -(% class="box warningmessage" %)
172 -(((
173 -**Редактирование клиента — PUT /api/v3/agents**
174 -)))
175 -
176 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
177 -
178 -Метод запроса: **PUT**
179 -
180 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
181 -
182 -В заголовках запроса: X-Auth: Токен авторизации
183 -
184 -
185 -Параметры в теле запроса (JSON):
186 -
187 -{
188 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
189 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
190 - "name": "string", ~/~/ имя
191 - "fullName": "string", ~/~/ полное наименование
192 - "isForeign": true, ~/~/ иностранный контрагент
193 - "district": "string", ~/~/ округ
194 - "region": "string", ~/~/ регион
195 - "city": "string", ~/~/ город
196 - "inn": "string", ~/~/ ИНН
197 - "kpp": "string", ~/~/ КПП
198 - "address": "string", ~/~/ юридический адрес
199 - "addressFact": "string", ~/~/ фактический адрес
200 - "email": "string", ~/~/ email
201 - "director": "string", ~/~/ ФИО руководителя
202 - "bankName": "string", ~/~/ банк
203 - "bankBIK": "string", ~/~/ БИК
204 - "bankRS": "string", ~/~/ номер счёта
205 - "bankKS": "string" ~/~/ корр. счёт
206 -}
207 -
208 -
209 -Ответ:
210 -
211 -{
212 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
213 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
214 - "name": "string", ~/~/ имя
215 - "fullName": "string", ~/~/ полное наименование
216 - "isForeign": true, ~/~/ иностранный контрагент
217 - "district": "string", ~/~/ округ
218 - "region": "string", ~/~/ регион
219 - "city": "string", ~/~/ город
220 - "inn": "string", ~/~/ ИНН
221 - "kpp": "string", ~/~/ КПП
222 - "address": "string", ~/~/ юридический адрес
223 - "addressFact": "string", ~/~/ фактический адрес
224 - "email": "string", ~/~/ email
225 - "director": "string", ~/~/ ФИО руководителя
226 - "bankName": "string", ~/~/ банк
227 - "bankBIK": "string", ~/~/ БИК
228 - "bankRS": "string", ~/~/ номер счёта
229 - "bankKS": "string" ~/~/ корр. счёт
230 -}
231 -
232 -
233 -(% class="box errormessage" %)
234 -(((
235 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
236 -)))
237 -
238 -
239 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
240 -
241 -Метод запроса: **DELETE**
242 -
243 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
244 -
245 -Параметр запроса: **{clientId}** - Guid пользователя
246 -
247 -В заголовках запроса: X-Auth: Токен авторизации
248 -
249 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
250 -
251 -
252 -
253 253  (% class="box" style="text-align: center;" %)
254 254  (((
255 255  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -276,9 +276,9 @@
276 276   "position": "", ~/~/ должность
277 277   "phone": "", ~/~/ телефон
278 278   "organization": "", ~/~/ организация
279 - "login": "", ~/~/ логин (обязателен)
280 - "password": "", ~/~/ пароль (обязателен)
281 - "email": "", ~/~/ email (обязателен)
140 + "login": "", ~/~/ логин
141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 + "email": "", ~/~/ email
282 282   "description": "", ~/~/ описание
283 283   "isEnabled": "", ~/~/ признак включения
284 284   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -313,7 +313,7 @@
313 313   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
314 314   "kind": "" , ~/~/ тип аутентификации
315 315   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
316 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
177 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
317 317  
318 318  (% style="text-align:left" %)
319 319  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -366,54 +366,6 @@
366 366  (% style="color:#000000" %)}
367 367  
368 368  
369 -(% class="box successmessage" %)
370 -(((
371 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
372 -)))
373 -
374 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
375 -
376 -(% style="color:#000000" %)Метод запроса: **GET**
377 -
378 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
379 -
380 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
381 -
382 -(% style="color:#000000" %)Ответ:
383 -
384 -(((
385 -(((
386 -{
387 - "id": "", ~/~/ GUID пользователя
388 - "lastName": "", ~/~/ Фамилия 
389 - "firstName": "", ~/~/ Имя
390 - "position": "", ~/~/ Должность
391 - "phone": "", ~/~/ Номер телефона
392 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
393 - "parentName": "", Наименование клиента, которому принадлежит пользователь
394 - "organization": "", ~/~/ Организация
395 - "login": "", ~/~/ Логин пользователя
396 - "email": "", ~/~/ Адрес электронной почты
397 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
398 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
399 - "description": "", ~/~/ Описание
400 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
401 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
402 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
403 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
404 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
405 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
406 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
407 - "groups": [], ~/~/ Список ролей пользователя
408 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
409 - "authDevices": [ ], ~/~/ Список авторизованных устройств
410 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
411 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
412 -}
413 -)))
414 -)))
415 -
416 -
417 417  (% class="box warningmessage" %)
418 418  (((
419 419  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -427,8 +427,6 @@
427 427  
428 428  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
429 429  
430 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
431 -
432 432  (% lang="en-US" style="text-align:left" %)
433 433  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
434 434  
... ... @@ -442,10 +442,10 @@
442 442   "position": "" , ~/~/ должность
443 443   "phone": "" , ~/~/ телефон
444 444   "organization": "" , ~/~/ организация
445 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
446 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
447 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
448 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
449 449   "isEnabled": "" , ~/~/ признак включения
450 450   "parentId": "" , ~/~/ Guid родительского агента
451 451   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -558,7 +558,6 @@
558 558  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
559 559  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
560 560  
561 -(((
562 562  В теле ответа:
563 563  {
564 564   "errorMessages": [
... ... @@ -571,7 +571,6 @@
571 571  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
572 572  "users" - массив id пользователей, которых не удалось включить или отключить.
573 573  
574 -)))
575 575  
576 576  (% class="box errormessage" %)
577 577  (((
... ... @@ -620,44 +620,77 @@
620 620  
621 621  (% style="color:#000000" %)Ответ:
622 622  
623 -(((
624 624  {
433 +
625 625   "vehicleId": "", ~/~/ ID объекта
435 +
626 626   "name": "", ~/~/ Имя объекта
437 +
627 627   "imei": "", ~/~/ IMEI объекта
439 +
628 628   "deviceTypeId": , ~/~/ ID типа устройства
441 +
629 629   "deviceTypeName": "", ~/~/ Название типа устройства
443 +
630 630   "sim1": "", ~/~/ Номер SIM1
445 +
631 631   "parentId": "", Номер SIM2
632 - "parentName": "", Наименование клиента-родителя
447 +
448 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 +
633 633   "modelId": "", ID модели объекта
451 +
634 634   "modelName": "", Имя модели объекта
453 +
635 635   "createdAt": "", Дата создания объекта
455 +
636 636   "mileageCalcMethod": "", Выбранный метод расчета пробега
457 +
637 637   "counters": { ~/~/ Нормы
459 +
638 638   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 +
639 639   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 +
640 640   "mileage": "", ~/~/ Пробег по нормам в метрах
465 +
641 641   "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 +
642 642   },
469 +
643 643   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 +
644 644   {
645 - "id": "", ~/~/ ID  задания
473 +
474 + "id": "", ~/~/ ID  задания
475 +
646 646   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477 +
647 647   "name": "", ~/~/ Наименование задания
479 +
648 648   "description": "", ~/~/ Описание задания
481 +
649 649   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 +
650 650   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 +
651 651   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 +
652 652   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 +
653 653   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 +
654 654   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 +
655 655   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 +
656 656   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 +
657 657   }
499 +
658 658   ]
501 +
659 659  }
660 -)))
661 661  
662 662  (% style="text-align:left" %)
663 663  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -818,17 +818,17 @@
818 818  
819 819  (% style="color:#000000" %)Параметры в теле запроса (JSON):
820 820  
821 -{
822 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
823 - "name": null, ~/~/ Имя ТС (string, опционально)
824 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
825 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
826 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
827 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
828 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
829 - "customFields": null ~/~/ значение любого из произвольных полей ТС
830 -}
663 +(% class="western" style="color:#000000" %)##{##
831 831  
665 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 + "name": null, ~/~/ Имя ТС (string, опционально) 
667 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 +(% style="color:#000000" %)}
673 +
832 832  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
833 833  
834 834  (% style="color:#000000" %)Ответ:
... ... @@ -851,16 +851,7 @@
851 851   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
852 852   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
853 853   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
854 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
855 - "customFields": [ 
856 - {
857 - "id": "", ~/~/ идентификатор произвольного поля
858 - "name": "", ~/~/ имя произвольного поля
859 - "value": "", ~/~/ значение произвольного поля
860 - "forClient": true, ~/~/ право на отображение у клиента
861 - "forTooltip": false, ~/~/ право на отображение в подсказке
862 - "forReport": false ~/~/ право на отображение в отчетах
863 - }(%%)
696 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
864 864  (% style="color:#000000" %)}
865 865  
866 866  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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