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
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Artem - Tags
-
... ... @@ -1,1 +1,0 @@ 1 -Public API|API - Content
-
... ... @@ -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" %)** POST25 + (% 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 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 } ... ... @@ -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 ... ... @@ -327,44 +327,6 @@ 327 327 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 328 328 329 329 330 -(% class="box warningmessage" %) 331 -((( 332 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 333 -))) 334 - 335 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 336 - 337 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 338 - 339 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 340 - 341 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 342 - 343 - [ 344 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 345 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 346 - ] 347 - 348 - 349 -(% class="box warningmessage" %) 350 -((( 351 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/find** 352 -))) 353 - 354 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 355 - 356 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 357 - 358 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 359 - 360 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 361 - 362 - [ 363 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 364 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 365 - ] 366 - 367 - 368 368 (% class="box errormessage" %) 369 369 ((( 370 370 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -463,22 +463,12 @@ 463 463 "sim2": "" , ~/~/ Номер SIM2 464 464 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 465 465 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 466 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 467 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 468 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 469 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 470 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 471 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 472 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 473 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 474 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 475 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 476 - "counters": ~/~/ счетчики 477 - { 478 - "mileage": "" , ~/~/ пробег 479 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 480 - "motohours": "" , ~/~/ моточасы 481 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 422 + "counters": { 423 + "mileage": "" , ~/~/ пробег 424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 425 + "motohours": "" , ~/~/ моточасы 426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 482 482 }, 483 483 "cmsv6Parameters": { ~/~/ параметры CMSv6 484 484 "enabled": true, ~/~/ флаг включения ... ... @@ -549,12 +549,7 @@ 549 549 (% style="text-align:left" %) 550 550 (% style="color:#000000" %)} 551 551 552 -**Валидация:** 553 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 554 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 555 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 556 556 557 - 558 558 (% class="box successmessage" %) 559 559 ((( 560 560 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -689,7 +689,6 @@ 689 689 690 690 (% style="color:#000000" %){ 691 691 692 -((( 693 693 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 694 694 "parentId": "", ~/~/ ID клиента 695 695 "name": "", ~/~/ имя ТС ... ... @@ -698,20 +698,10 @@ 698 698 "modelId": "", ~/~/ , ID модели 699 699 "unitId": "", ~/~/ подразделения 700 700 "sim1": "", ~/~/ SIM 1 701 - "sim2": "", ~/~/ SIM2 (%%) 702 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 703 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 704 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 705 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 706 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 707 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 708 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 709 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 710 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 711 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 712 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 713 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 714 -(% style="color:#000000" %) "counters": 640 + "sim2": "", ~/~/ SIM2 641 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 642 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 643 + "counters": 715 715 { 716 716 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 717 717 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» ... ... @@ -740,7 +740,6 @@ 740 740 "kind": "", ~/~/ Вид периодичности по времени 741 741 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 742 742 } 743 -))) 744 744 745 745 (% style="color:#000000" %)} 746 746 ... ... @@ -794,12 +794,7 @@ 794 794 (% lang="en-US" style="text-align:left" %) 795 795 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 796 796 797 -**валидация:** 798 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 799 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 800 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 801 801 802 - 803 803 (% class="box errormessage" %) 804 804 ((( 805 805 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**