Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 25.6 >
edited by Артем Шемяков
on 2022/09/05 11:13
To version < 28.8 >
edited by Артем Шемяков
on 2022/09/22 10:19
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -20,20 +20,27 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
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]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% lang="en-US" %)
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
43 +
37 37  (% style="color:#000000" %)**Ответ:**
38 38  
39 39  (% lang="en-US" %)
... ... @@ -40,8 +40,8 @@
40 40  (% style="color:#000000" %){
41 41  
42 42  (% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 47  }
... ... @@ -100,7 +100,7 @@
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 102   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформление, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
110 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
104 104  }
105 105  
106 106  
... ... @@ -418,12 +418,22 @@
418 418   "sim2": "" , ~/~/ Номер SIM2
419 419   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 420   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 - "counters": {
423 - "mileage": "" , ~/~/ пробег
424 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 - "motohours": "" , ~/~/ моточасы
426 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
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 ~/~/ флаг активности счётчика "моточасы"
427 427   },
428 428   "cmsv6Parameters": { ~/~/ параметры CMSv6
429 429   "enabled": true, ~/~/ флаг включения
... ... @@ -494,7 +494,12 @@
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
496 496  
514 +**Валидация:**
515 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
516 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
517 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
497 497  
519 +
498 498  (% class="box successmessage" %)
499 499  (((
500 500  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -629,6 +629,7 @@
629 629  
630 630  (% style="color:#000000" %){    
631 631  
654 +(((
632 632  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
633 633   "parentId": "", ~/~/ ID клиента
634 634   "name": "", ~/~/ имя ТС
... ... @@ -637,10 +637,20 @@
637 637   "modelId": "", ~/~/ , ID модели    
638 638   "unitId": "", ~/~/ подразделения
639 639   "sim1": "", ~/~/ SIM 1
640 - "sim2": "", ~/~/ SIM2
641 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 - "counters": 
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": 
644 644   {
645 645   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
646 646   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
... ... @@ -669,6 +669,7 @@
669 669   "kind": "", ~/~/ Вид периодичности по времени
670 670   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
671 671   } 
705 +)))
672 672  
673 673  (% style="color:#000000" %)}
674 674  
... ... @@ -722,7 +722,12 @@
722 722  (% lang="en-US" style="text-align:left" %)
723 723  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
724 724  
759 +**валидация:**
760 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
761 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
762 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
725 725  
764 +
726 726  (% class="box errormessage" %)
727 727  (((
728 728  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

Меню

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