Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
Добавлен тег [Public API]
Summary
Details
- Page properties
-
- Tags
-
... ... @@ -1,1 +1,1 @@ 1 -Public API |API1 +Public 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 } ... ... @@ -425,22 +425,12 @@ 425 425 "sim2": "" , ~/~/ Номер SIM2 426 426 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 427 427 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 428 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 429 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 430 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 431 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 432 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 433 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 434 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 435 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 436 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 437 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 438 - "counters": ~/~/ счетчики 439 - { 440 - "mileage": "" , ~/~/ пробег 441 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 442 - "motohours": "" , ~/~/ моточасы 443 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 422 + "counters": { 423 + "mileage": "" , ~/~/ пробег 424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 425 + "motohours": "" , ~/~/ моточасы 426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 444 444 }, 445 445 "cmsv6Parameters": { ~/~/ параметры CMSv6 446 446 "enabled": true, ~/~/ флаг включения ... ... @@ -511,12 +511,7 @@ 511 511 (% style="text-align:left" %) 512 512 (% style="color:#000000" %)} 513 513 514 -**Валидация:** 515 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 516 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 517 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 518 518 519 - 520 520 (% class="box successmessage" %) 521 521 ((( 522 522 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -659,20 +659,10 @@ 659 659 "modelId": "", ~/~/ , ID модели 660 660 "unitId": "", ~/~/ подразделения 661 661 "sim1": "", ~/~/ SIM 1 662 - "sim2": "", ~/~/ SIM2 (%%) 663 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 664 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 665 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 666 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 667 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 668 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 669 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 670 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 671 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 672 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 673 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 674 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 675 -(% style="color:#000000" %) "counters": 640 + "sim2": "", ~/~/ SIM2 641 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 642 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 643 + "counters": 676 676 { 677 677 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 678 678 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» ... ... @@ -754,12 +754,7 @@ 754 754 (% lang="en-US" style="text-align:left" %) 755 755 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 756 756 757 -**валидация:** 758 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 759 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 760 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 761 761 762 - 763 763 (% class="box errormessage" %) 764 764 ((( 765 765 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**