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" %) ... ... @@ -195,7 +195,7 @@ 195 195 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 196 196 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 197 197 198 -(% style="color:#000000" %)} 201 +(% style="color:#000000" %) } 199 199 200 200 (% style="color:#000000" %)Ответ: 201 201 ... ... @@ -215,7 +215,7 @@ 215 215 "status": "1", ~/~/ статус пользователя 216 216 "astLogged": "", ~/~/ дата/время последней авторизации 217 217 218 -(% style="color:#000000" %)} 221 +(% style="color:#000000" %) } 219 219 220 220 221 221 (% class="box warningmessage" %) ... ... @@ -258,16 +258,16 @@ 258 258 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 259 259 260 260 (% lang="en-US" style="text-align:left" %) 261 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 262 262 263 263 (% lang="en-US" style="text-align:left" %) 264 264 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 265 265 266 266 (% lang="en-US" style="text-align:left" %) 267 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 268 268 269 269 (% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 271 271 "lastName": "" , ~/~/ фамилия 272 272 "firstName": "" , ~/~/ имя 273 273 "position": "" , ~/~/ должность ... ... @@ -283,10 +283,10 @@ 283 283 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 284 284 "kind": "" , ~/~/ тип аутентификации 285 285 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 286 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 287 287 288 288 (% lang="en-US" style="text-align:left" %) 289 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 290 290 291 291 292 292 (% class="box warningmessage" %) ... ... @@ -312,7 +312,7 @@ 312 312 "description": "" , ~/~/ описание 313 313 "data": "" , ~/~/ данные, связанные со сменой статуса 314 314 315 -(% style="color:#000000" %)} 318 + (% style="color:#000000" %)} 316 316 317 317 (% style="text-align:left" %) 318 318 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** ... ... @@ -380,7 +380,7 @@ 380 380 "unitName": "" , ~/~/ наименование подразделения 381 381 "status": "" , ~/~/ статус объекта 382 382 383 -} 386 + } 384 384 385 385 (% style="text-align:left" %) 386 386 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -422,7 +422,7 @@ 422 422 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 423 423 "motohours": "" , ~/~/ моточасы 424 424 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 425 - 428 + }, 426 426 "cmsv6Parameters": { ~/~/ параметры CMSv6 427 427 "enabled": true, ~/~/ флаг включения 428 428 "id": "" , ~/~/ идентификатор ... ... @@ -429,7 +429,7 @@ 429 429 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 430 430 "login": "" , ~/~/ имя учетной записи 431 431 "password": "" ~/~/ пароль учетной записи 432 - 435 + }, 433 433 "inspectionTasks": ~/~/ задания на ТО 434 434 { 435 435 "enabled": "" , ~/~/ Признак включения ... ... @@ -467,7 +467,7 @@ 467 467 "motohoursEnabled": true, 468 468 "mileage": "", 469 469 "motohours": 345.0 470 - 473 + }, 471 471 "cmsv6Parameters": { ~/~/Параметры CmsV6 472 472 "id": null, 473 473 "enabled": true, ~/~/флаг включения ... ... @@ -474,7 +474,7 @@ 474 474 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 475 475 "login": "", ~/~/ имя учетной записи 476 476 "password": "" ~/~/ пароль учетной записи 477 - 480 + }, 478 478 "inspectionTasks": { ~/~/ задания на ТО 479 479 "id": "", ~/~/ ID задачи 480 480 "enabled": false, ~/~/ Признак включения ... ... @@ -487,7 +487,7 @@ 487 487 "periodicCondition": "", ~/~/ Условие периодичности по времени 488 488 "kind": "", ~/~/ Вид периодичности по времени 489 489 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 490 - } 493 + } 491 491 492 492 (% style="text-align:left" %) 493 493 (% style="color:#000000" %)} ... ... @@ -591,7 +591,7 @@ 591 591 "overwrite": false, ~/~/ Флаг перезаписи 592 592 "stage": "", ~/~/ Состояние, может быть null 593 593 594 -(% style="color:#000000" %)} 597 + (% style="color:#000000" %)} 595 595 596 596 (% style="color:#000000" %)Ответ: 597 597 ... ... @@ -605,7 +605,7 @@ 605 605 "stage": "", ~/~/ Состояние 606 606 607 607 (% style="text-align:left" %) 608 -(% style="color:#000000" %) 611 +(% style="color:#000000" %)} 609 609 610 610 611 611 (% class="box warningmessage" %) ... ... @@ -623,102 +623,14 @@ 623 623 624 624 (% style="color:#000000" %)Параметры в теле запроса (JSON): 625 625 626 -(% style="color:#000000" %){ 629 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «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»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 627 627 628 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 629 - "parentId": "", ~/~/ ID клиента 630 - "name": "", ~/~/ имя ТС 631 - "imei": "", ~/~/ IMEI 632 - "deviceTypeId": "", ~/~/ ID типа устройства 633 - "modelId": "", ~/~/ , ID модели 634 - "unitId": "", ~/~/ подразделения 635 - "sim1": "", ~/~/ SIM 1 636 - "sim2": "", ~/~/ SIM2 637 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 638 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 639 - "counters": 640 - { 641 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 642 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 643 - "mileage": «», пробег 644 - "motohours": «» моточасы 645 - } 646 - "cmsv6Parameters": ~/~/ параметры CMSv6 647 - { 648 - "id": "", ~/~/ идентификатор 649 - "enabled": true, ~/~/ флаг включения 650 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 651 - "login": "", ~/~/ имя учетной записи 652 - "password": "", ~/~/ пароль учетной записи 653 - } 654 - "inspectionTasks": ~/~/ задания на ТО 655 - { 656 - "id": "", ~/~/ ID задания 657 - "enabled": false, ~/~/ Признак включения 658 - "name": "", ~/~/ Имя задания 659 - "description": "", ~/~/ Описание задания 660 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 661 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 662 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 663 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 664 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 665 - "kind": "", ~/~/ Вид периодичности по времени 666 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 667 - } 668 - 669 -(% style="color:#000000" %)} 670 - 671 671 (% style="color:#000000" %)Ответ: 672 672 673 673 (% lang="en-US" style="text-align:left" %) 674 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 634 +(% 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»: «» //Сколько раз выполнить задание } ] } 675 675 676 -(% lang="en-US" style="text-align:left" %) 677 - "vehicleId": "", ~/~/ ID ТС 678 - "parentId": "", ~/~/ ID клиента 679 - "name": "", ~/~/ имя ТС 680 - "imei": "", ~/~/ IMEI 681 - "deviceTypeId": "", ~/~/ типа устройства 682 - "modelId": "", ~/~/ ID модели 683 - "unitId": "", ~/~/ ID подразделения 684 - "sim1": "", ~/~/ SIM 1 685 - "sim2": "", ~/~/ SIM2 686 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 687 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 688 - "counters": 689 - { 690 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 691 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 692 - "mileage": "", ~/~/ пробег 693 - "motohours": "", ~/~/ моточасы 694 - } 695 - "cmsv6Parameters": ~/~/ параметры CMSv6 696 - { 697 - "id": ~/~/ идентификатор 698 - "enabled": true, ~/~/ флаг включения 699 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 700 - "login": "", ~/~/ имя учетной записи 701 - "password": "", ~/~/ пароль учетной записи 702 - } 703 - "inspectionTasks": ~/~/ задания на ТО 704 - { 705 - "id": "", ~/~/ ID задания 706 - "enabled": false, ~/~/ Признак включения 707 - "name": "", ~/~/ Имя задания 708 - "description": "", ~/~/ Описание задания 709 - "mileageCondition": "", ~/~/ Условие по пробегу 710 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 711 - "motohoursCondition": "", ~/~/ Условие по моточасам 712 - "lastMotohours": "", ~/~/ Моточасы 713 - "periodicCondition": "", ~/~/ Условие периодичности по времени 714 - "kind": "", ~/~/ Вид периодичности по времени 715 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 716 - } 717 717 718 -(% lang="en-US" style="text-align:left" %) 719 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 720 - 721 - 722 722 (% class="box errormessage" %) 723 723 ((( 724 724 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -756,15 +756,16 @@ 756 756 757 757 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 758 758 759 -(% style="color:#000000" %)Ответ: 674 +(% style="color:#000000" %)Ответ: [ 760 760 761 -(% style="color:#000000" %){ 676 +(% class="western" %) 677 +{{{ { 678 + "deviceTypeId" : "", // ID типа устройства 679 + "deviceTypeName" : "" // Название типа устройства 680 + },}}} 762 762 763 - "deviceTypeId" : "", ~/~/ ID типа устройства 764 - "deviceTypeName" : "" ~/~/ Название типа устройства 765 - 766 766 (% style="text-align:left" %) 767 -(% style="color:#000000" %) }683 +(% style="color:#000000" %)…** **] 768 768 769 769 770 770 (% class="box" style="text-align: center;" %) ... ... @@ -785,16 +785,19 @@ 785 785 786 786 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 787 787 788 -(% style="color:#000000" %)Ответ: 704 +(% style="color:#000000" %)Ответ: [ 789 789 790 -(% style="color:#000000" %){ 706 +(% class="western" style="margin-bottom:19px" %) 707 +{{{ {}}} 791 791 792 - "id": "", ~/~/ ID типа датчика 793 - "name": "", ~/~/ Название 794 - "description": "", ~/~/ Описание 709 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 795 795 711 +(% class="western" %) 712 +{{{ "description": "" // Описание 713 + },}}} 714 + 796 796 (% style="text-align:left" %) 797 -(% style="color:#000000" %) }716 +(% style="color:#000000" %)… ] 798 798 799 799 800 800 (% class="box" lang="en-US" style="text-align: center;" %)