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

Меню

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