Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- 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 ... ... @@ -31,7 +31,7 @@ 31 31 32 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" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% lang="en-US" %) 37 37 (% style="color:#000000" %)**Ответ:** ... ... @@ -44,7 +44,7 @@ 44 44 "User": "" , ~/~/ имя пользователя 45 45 46 46 (% lang="en-US" %) 47 -} 47 + } 48 48 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 ... ... @@ -82,13 +82,13 @@ 82 82 83 83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 84 84 85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права « __**Доступ к партнёрским клиентам**__».85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 86 86 87 87 (% style="color:#000000" %)Метод запроса: **GET** 88 88 89 89 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId> 90 90 91 -(% style="color:#000000" %)Параметр запроса: < __**parentId**__> - идентификатор клиента-родителя (опционально)91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 92 92 93 93 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 94 94 ... ... @@ -99,11 +99,14 @@ 99 99 "parentId": "", ~/~/ идентификатор клиента-родителя 100 100 "name": "", ~/~/ наименование клиента 101 101 "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент,1-Партнер,2-Группа,3-Административнаягруппа, 4 - Тестовый клиент, 5 - Договор)102 + "agentInfoType": "", ~/~/ тип клиента1 103 103 "status": "", ~/~/ статус клиента 104 -} 104 + } 105 105 106 106 107 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 108 + 109 + 107 107 (% class="box" style="text-align: center;" %) 108 108 ((( 109 109 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -142,7 +142,7 @@ 142 142 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 143 143 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 144 144 "groups": "" , ~/~/ группы пользователя, названия групп 145 -} 148 + } 146 146 147 147 (% style="text-align:left" %) 148 148 (% style="color:#000000; font-weight:normal" %)Ответ: ... ... @@ -170,7 +170,7 @@ 170 170 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 171 171 172 172 (% style="text-align:left" %) 173 -(% style="color:#000000; font-weight:normal" %)} 176 +(% style="color:#000000; font-weight:normal" %) } 174 174 175 175 176 176 (% class="box successmessage" %) ... ... @@ -186,10 +186,8 @@ 186 186 187 187 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 188 188 189 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 190 190 191 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 192 - 193 193 (% style="color:#000000" %){ 194 194 195 195 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента ... ... @@ -197,7 +197,7 @@ 197 197 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 198 198 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 199 199 200 -(% style="color:#000000" %)} 201 +(% style="color:#000000" %) } 201 201 202 202 (% style="color:#000000" %)Ответ: 203 203 ... ... @@ -217,7 +217,7 @@ 217 217 "status": "1", ~/~/ статус пользователя 218 218 "astLogged": "", ~/~/ дата/время последней авторизации 219 219 220 -(% style="color:#000000" %)} 221 +(% style="color:#000000" %) } 221 221 222 222 223 223 (% class="box warningmessage" %) ... ... @@ -260,16 +260,16 @@ 260 260 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 261 261 262 262 (% lang="en-US" style="text-align:left" %) 263 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 264 264 265 265 (% lang="en-US" style="text-align:left" %) 266 266 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 267 267 268 268 (% lang="en-US" style="text-align:left" %) 269 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 270 270 271 271 (% lang="en-US" style="text-align:left" %) 272 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 273 273 "lastName": "" , ~/~/ фамилия 274 274 "firstName": "" , ~/~/ имя 275 275 "position": "" , ~/~/ должность ... ... @@ -285,10 +285,10 @@ 285 285 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 286 286 "kind": "" , ~/~/ тип аутентификации 287 287 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 288 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 289 289 290 290 (% lang="en-US" style="text-align:left" %) 291 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 292 292 293 293 294 294 (% class="box warningmessage" %) ... ... @@ -302,7 +302,7 @@ 302 302 303 303 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 304 304 305 -(% style="color:#000000" %)Параметр запроса: { __**id**__} - Guid пользователя306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 306 306 307 307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 308 308 ... ... @@ -314,7 +314,7 @@ 314 314 "description": "" , ~/~/ описание 315 315 "data": "" , ~/~/ данные, связанные со сменой статуса 316 316 317 -(% style="color:#000000" %)} 318 + (% style="color:#000000" %)} 318 318 319 319 (% style="text-align:left" %) 320 320 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** ... ... @@ -331,7 +331,7 @@ 331 331 332 332 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 333 333 334 -(% style="color:#000000" %)Параметр запроса: { **__id__**} - Guid пользователя335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 335 335 336 336 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 337 337 ... ... @@ -355,13 +355,13 @@ 355 355 356 356 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 357 357 358 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **« __Просмотр заданий на техобслуживание__»**.359 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 359 359 360 360 (% style="color:#000000" %)Метод запроса: **GET** 361 361 362 362 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID> 363 363 364 -(% style="color:#000000" %)Параметр запроса: < __**vehicleid**__> - идентификатор объекта (опционально)365 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 365 365 366 366 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 367 367 ... ... @@ -382,7 +382,7 @@ 382 382 "unitName": "" , ~/~/ наименование подразделения 383 383 "status": "" , ~/~/ статус объекта 384 384 385 -} 386 + } 386 386 387 387 (% style="text-align:left" %) 388 388 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -424,7 +424,7 @@ 424 424 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 425 425 "motohours": "" , ~/~/ моточасы 426 426 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 427 - 428 + }, 428 428 "cmsv6Parameters": { ~/~/ параметры CMSv6 429 429 "enabled": true, ~/~/ флаг включения 430 430 "id": "" , ~/~/ идентификатор ... ... @@ -431,7 +431,7 @@ 431 431 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 432 432 "login": "" , ~/~/ имя учетной записи 433 433 "password": "" ~/~/ пароль учетной записи 434 - 435 + }, 435 435 "inspectionTasks": ~/~/ задания на ТО 436 436 { 437 437 "enabled": "" , ~/~/ Признак включения ... ... @@ -469,7 +469,7 @@ 469 469 "motohoursEnabled": true, 470 470 "mileage": "", 471 471 "motohours": 345.0 472 - 473 + }, 473 473 "cmsv6Parameters": { ~/~/Параметры CmsV6 474 474 "id": null, 475 475 "enabled": true, ~/~/флаг включения ... ... @@ -476,7 +476,7 @@ 476 476 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 477 477 "login": "", ~/~/ имя учетной записи 478 478 "password": "" ~/~/ пароль учетной записи 479 - 480 + }, 480 480 "inspectionTasks": { ~/~/ задания на ТО 481 481 "id": "", ~/~/ ID задачи 482 482 "enabled": false, ~/~/ Признак включения ... ... @@ -489,7 +489,7 @@ 489 489 "periodicCondition": "", ~/~/ Условие периодичности по времени 490 490 "kind": "", ~/~/ Вид периодичности по времени 491 491 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 492 - } 493 + } 493 493 494 494 (% style="text-align:left" %) 495 495 (% style="color:#000000" %)} ... ... @@ -593,7 +593,7 @@ 593 593 "overwrite": false, ~/~/ Флаг перезаписи 594 594 "stage": "", ~/~/ Состояние, может быть null 595 595 596 -(% style="color:#000000" %)} 597 + (% style="color:#000000" %)} 597 597 598 598 (% style="color:#000000" %)Ответ: 599 599 ... ... @@ -607,7 +607,7 @@ 607 607 "stage": "", ~/~/ Состояние 608 608 609 609 (% style="text-align:left" %) 610 -(% style="color:#000000" %) 611 +(% style="color:#000000" %)} 611 611 612 612 613 613 (% class="box warningmessage" %) ... ... @@ -625,7 +625,7 @@ 625 625 626 626 (% style="color:#000000" %)Параметры в теле запроса (JSON): 627 627 628 -(% style="color:#000000" %){ 629 +(% style="color:#000000" %) { 629 629 630 630 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 631 631 "parentId": "", ~/~/ ID клиента ... ... @@ -666,7 +666,7 @@ 666 666 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 667 667 "kind": "", ~/~/ Вид периодичности по времени 668 668 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 669 - 670 + } 670 670 671 671 (% style="color:#000000" %)} 672 672 ... ... @@ -673,54 +673,9 @@ 673 673 (% style="color:#000000" %)Ответ: 674 674 675 675 (% lang="en-US" style="text-align:left" %) 676 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 677 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 677 677 678 -(% lang="en-US" style="text-align:left" %) 679 - "vehicleId": "", ~/~/ ID ТС 680 - "parentId": "", ~/~/ ID клиента 681 - "name": "", ~/~/ имя ТС 682 - "imei": "", ~/~/ IMEI 683 - "deviceTypeId": "", ~/~/ типа устройства 684 - "modelId": "", ~/~/ ID модели 685 - "unitId": "", ~/~/ ID подразделения 686 - "sim1": "", ~/~/ SIM 1 687 - "sim2": "", ~/~/ SIM2 688 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 689 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 690 - "counters": 691 - { 692 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 693 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 694 - "mileage": "", ~/~/ пробег 695 - "motohours": "", ~/~/ моточасы 696 - } 697 - "cmsv6Parameters": ~/~/ параметры CMSv6 698 - { 699 - "id": ~/~/ идентификатор 700 - "enabled": true, ~/~/ флаг включения 701 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 702 - "login": "", ~/~/ имя учетной записи 703 - "password": "", ~/~/ пароль учетной записи 704 - } 705 - "inspectionTasks": ~/~/ задания на ТО 706 - { 707 - "id": "", ~/~/ ID задания 708 - "enabled": false, ~/~/ Признак включения 709 - "name": "", ~/~/ Имя задания 710 - "description": "", ~/~/ Описание задания 711 - "mileageCondition": "", ~/~/ Условие по пробегу 712 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 713 - "motohoursCondition": "", ~/~/ Условие по моточасам 714 - "lastMotohours": "", ~/~/ Моточасы 715 - "periodicCondition": "", ~/~/ Условие периодичности по времени 716 - "kind": "", ~/~/ Вид периодичности по времени 717 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 718 - } 719 719 720 -(% lang="en-US" style="text-align:left" %) 721 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 722 - 723 - 724 724 (% class="box errormessage" %) 725 725 ((( 726 726 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -758,15 +758,16 @@ 758 758 759 759 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 760 760 761 -(% style="color:#000000" %)Ответ: 717 +(% style="color:#000000" %)Ответ: [ 762 762 763 -(% style="color:#000000" %){ 719 +(% class="western" %) 720 +{{{ { 721 + "deviceTypeId" : "", // ID типа устройства 722 + "deviceTypeName" : "" // Название типа устройства 723 + },}}} 764 764 765 - "deviceTypeId" : "", ~/~/ ID типа устройства 766 - "deviceTypeName" : "" ~/~/ Название типа устройства 767 - 768 768 (% style="text-align:left" %) 769 -(% style="color:#000000" %) }726 +(% style="color:#000000" %)…** **] 770 770 771 771 772 772 (% class="box" style="text-align: center;" %) ... ... @@ -787,16 +787,19 @@ 787 787 788 788 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 789 789 790 -(% style="color:#000000" %)Ответ: 747 +(% style="color:#000000" %)Ответ: [ 791 791 792 -(% style="color:#000000" %){ 749 +(% class="western" style="margin-bottom:19px" %) 750 +{{{ {}}} 793 793 794 - "id": "", ~/~/ ID типа датчика 795 - "name": "", ~/~/ Название 796 - "description": "", ~/~/ Описание 752 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 797 797 754 +(% class="western" %) 755 +{{{ "description": "" // Описание 756 + },}}} 757 + 798 798 (% style="text-align:left" %) 799 -(% style="color:#000000" %) }759 +(% style="color:#000000" %)… ] 800 800 801 801 802 802 (% class="box" lang="en-US" style="text-align: center;" %)