<
From version < 27.1 >
edited by Артем Шемяков
on 2022/09/20 09:17
To version < 23.1 >
edited by Артем Шемяков
on 2022/09/02 10:15
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -20,27 +20,20 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «(% style="color: rgb(0, 0, 0);" %)__**AuthId**__(% style="color:#000000" %)» содержит токен авторизации «(% style="color: rgb(0, 0, 0);" %)__**X-Auth**__(% style="color:#000000" %)».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}(%%)
42 -
43 -
36 +(% lang="en-US" %)
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -47,8 +47,8 @@
47 47  (% style="color:#000000" %){
48 48  
49 49  (% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
52 52  
53 53  (% lang="en-US" %)
54 54  }
... ... @@ -61,7 +61,7 @@
61 61  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,7 +83,7 @@
83 83  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -107,7 +107,7 @@
107 107   "name": "", ~/~/ наименование клиента
108 108   "fullName": "", ~/~/ полное наименование клиента
109 109   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
103 + "status": "", ~/~/ статус клиента
111 111  }
112 112  
113 113  
... ... @@ -121,7 +121,7 @@
121 121  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -187,7 +187,7 @@
187 187  
188 188  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
191 191  
192 192  (% style="color:#000000" %)Метод запроса: **POST**
193 193  
... ... @@ -232,7 +232,7 @@
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -303,7 +303,7 @@
303 303  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -332,7 +332,7 @@
332 332  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 333  )))
334 334  
335 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
336 336  
337 337  (% style="color:#000000" %)Метод запроса: **DELETE**
338 338  
... ... @@ -358,7 +358,7 @@
358 358  
359 359  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
360 360  
361 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
362 362  
363 363  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
364 364  
... ... @@ -403,7 +403,7 @@
403 403  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
404 404  )))
405 405  
406 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
407 407  
408 408  (% style="color:#000000" %)Метод запроса: **POST**
409 409  
... ... @@ -509,7 +509,7 @@
509 509  
510 510  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
511 511  
512 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
513 513  
514 514  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
515 515  
... ... @@ -537,13 +537,13 @@
537 537  
538 538  (% class="western" style="color:#000000" %)##{##
539 539  
540 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
541 541   "name": null, ~/~/ Имя ТС (string, опционально) 
542 542   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
543 543   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
544 544   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
545 545   "parentId": null, ~/~/ ID клиента (Guid, опционально) 
546 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
547 547  (% style="color:#000000" %)}
548 548  
549 549  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -565,21 +565,23 @@
565 565   "modelName": "" ~/~/ наименование модели объекта
566 566   "unitId": "" ~/~/ идентификатор подразделения
567 567   "unitName": "" ~/~/ наименование подразделения
568 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
569 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
570 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
571 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
572 572  (% style="color:#000000" %)}
573 573  
574 574  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
575 575  
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
576 576  
569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 +
571 +
577 577  (% class="box successmessage" %)
578 578  (((
579 579  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
580 580  )))
581 581  
582 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
583 583  
584 584  (% style="color:#000000" %)Метод запроса: **POST**
585 585  
... ... @@ -624,7 +624,7 @@
624 624  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
625 625  )))
626 626  
627 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
628 628  
629 629  (% style="color:#000000" %)Метод запроса: **PUT**
630 630  
... ... @@ -735,7 +735,7 @@
735 735  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
736 736  )))
737 737  
738 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
739 739  
740 740  (% style="color:#000000" %)Метод запроса: **DELETE**
741 741  
... ... @@ -759,7 +759,7 @@
759 759  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
760 760  )))
761 761  
762 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
763 763  
764 764  (% style="color:#000000" %)Метод запроса: **GET**
765 765  
... ... @@ -788,7 +788,7 @@
788 788  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
789 789  )))
790 790  
791 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
792 792  
793 793  (% style="color:#000000" %)Метод запроса: **GET**
794 794  

Меню

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