Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 28.8 >
edited by Артем Шемяков
on 2022/09/22 10:19
To version < 26.2 >
edited by Артем Шемяков
on 2022/09/15 15:19
>
Change comment: Добавлен тег [Public API]

Summary

Details

Icon Page properties
Tags
... ... @@ -1,1 +1,1 @@
1 -Public API|API
1 +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" %)**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 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**
... ... @@ -651,7 +651,6 @@
651 651  
652 652  (% style="color:#000000" %){    
653 653  
654 -(((
655 655  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
656 656   "parentId": "", ~/~/ ID клиента
657 657   "name": "", ~/~/ имя ТС
... ... @@ -660,20 +660,10 @@
660 660   "modelId": "", ~/~/ , ID модели    
661 661   "unitId": "", ~/~/ подразделения
662 662   "sim1": "", ~/~/ SIM 1
663 - "sim2": "", ~/~/ SIM2 (%%)
664 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
665 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
666 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
667 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
668 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
669 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
670 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
671 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
672 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
673 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
674 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
675 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
676 -(% style="color:#000000" %) "counters": 
640 + "sim2": "", ~/~/ SIM2
641 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 + "counters": 
677 677   {
678 678   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
679 679   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
... ... @@ -702,7 +702,6 @@
702 702   "kind": "", ~/~/ Вид периодичности по времени
703 703   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
704 704   } 
705 -)))
706 706  
707 707  (% style="color:#000000" %)}
708 708  
... ... @@ -756,12 +756,7 @@
756 756  (% lang="en-US" style="text-align:left" %)
757 757  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
758 758  
759 -**валидация:**
760 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
761 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
762 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
763 763  
764 -
765 765  (% class="box errormessage" %)
766 766  (((
767 767  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

Меню

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