Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,11 +1,11 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -= Описание ГЛОНАССSoft Public API 3.0 = 2 +== Описание ГЛОНАССSoft Public API 3.0 == 3 3 4 4 5 5 {{toc/}} 6 6 7 7 8 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 8 +==== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ==== 9 9 10 10 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 ... ... @@ -15,10 +15,12 @@ 15 15 16 16 (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 17 18 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 19 19 20 -== (% style="color:#000000; font-size:1 6px" %)**Авторизация**(%%) ==19 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Авторизация**(%%) ==== 21 21 21 + 22 +===== (% style="color:#000000; line-height:100%" %)**Авторизация**(%%) ===== 23 + 22 22 (% class="box infomessage" %) 23 23 ((( 24 24 (% lang="en-US" %)**POST /api/v3/auth/login** ... ... @@ -38,8 +38,8 @@ 38 38 "login": "testuser", 39 39 "password": "testuser" 40 40 }(%%) 43 + 41 41 42 - 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) ... ... @@ -54,8 +54,9 @@ 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 56 56 57 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 58 58 60 +===== (% style="color:#000000; line-height:100%" %)**Проверка авторизации**(%%) ===== 61 + 59 59 (% class="box infomessage" %) 60 60 ((( 61 61 (% lang="en-US" %)**GET /api/v3/auth/check** ... ... @@ -72,10 +72,12 @@ 72 72 (% lang="en-US" %) 73 73 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 74 74 75 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 76 76 77 -== (% style="color:#000000; font-size:1 6px" %)**Получение основных параметровклиента**(%%) ==79 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Клиенты**(%%) ==== 78 78 81 + 82 +===== (% style="color:#000000" %)**Получение основных параметров клиента**(%%) ===== 83 + 79 79 (% class="box infomessage" %) 80 80 ((( 81 81 (% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** ... ... @@ -108,8 +108,9 @@ 108 108 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 109 109 } 110 110 111 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 112 112 117 +===== **Добавление клиента** ===== 118 + 113 113 (% class="box successmessage" %) 114 114 ((( 115 115 **POST /api/v3/agents ** ... ... @@ -169,8 +169,9 @@ 169 169 "bankKS": "string" ~/~/ корр. счёт 170 170 } 171 171 172 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 173 173 179 +===== **Редактирование клиента** ===== 180 + 174 174 (% class="box warningmessage" %) 175 175 ((( 176 176 **PUT /api/v3/agents** ... ... @@ -232,8 +232,9 @@ 232 232 "bankKS": "string" ~/~/ корр. счёт 233 233 } 234 234 235 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 236 236 243 +===== **Удаление клиента** ===== 244 + 237 237 (% class="box errormessage" %) 238 238 ((( 239 239 **DELETE /api/v3/agents/{clientId}** ... ... @@ -251,10 +251,12 @@ 251 251 252 252 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 253 253 254 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 255 255 256 -== (% style="color:#000000; font-size:1 6px" %)**Добавлениепользователя**(%%) ==263 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Пользователи**(%%) ==== 257 257 265 + 266 +===== (% style="color:#000000; line-height:100%" %)**Добавление пользователя**(%%) ===== 267 + 258 258 (% class="box successmessage" %) 259 259 ((( 260 260 (% lang="en-US" %)**POST /api/v3/users** ... ... @@ -319,7 +319,7 @@ 319 319 (% style="color:#000000; font-weight:normal" %)} 320 320 321 321 322 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==332 +===== (% style="color:#000000; line-height:100%" %)**Получение списка пользователей**(%%) ===== 323 323 324 324 (% class="box successmessage" %) 325 325 ((( ... ... @@ -368,7 +368,7 @@ 368 368 (% style="color:#000000" %)} 369 369 370 370 371 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==381 +===== (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе**(%%) ===== 372 372 373 373 (% class="box successmessage" %) 374 374 ((( ... ... @@ -418,7 +418,7 @@ 418 418 ))) 419 419 420 420 421 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==431 +===== (% style="color:#000000; line-height:100%" %)**Редактирование пользователя**(%%) ===== 422 422 423 423 (% class="box warningmessage" %) 424 424 ((( ... ... @@ -491,7 +491,7 @@ 491 491 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 492 492 493 493 494 -== (% style="color:#000000 , font-size:14px" %)**Изменение статуса пользователя**(%%) ==504 +===== (% style="color:#000000" %)**Изменение статуса пользователя**(%%) ===== 495 495 496 496 (% class="box warningmessage" %) 497 497 ((( ... ... @@ -522,7 +522,7 @@ 522 522 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 523 523 524 524 525 -== (% style="color:#000000,font-size:14px" %)**Блокировка пользователей**(%%)==535 +===== **Блокировка пользователей** ===== 526 526 527 527 (% class="box warningmessage" %) 528 528 ((( ... ... @@ -545,7 +545,7 @@ 545 545 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 546 546 547 547 548 -== (% style="color:#000000,font-size:14px" %)**Разблокировка пользователей**(%%)==558 +===== **Разблокировка пользователей** ===== 549 549 550 550 (% class="box warningmessage" %) 551 551 ((( ... ... @@ -582,7 +582,7 @@ 582 582 "users" - массив id пользователей, которых не удалось включить или отключить. 583 583 584 584 585 -== (% style="color:#000000; line-height:1 4px" %)**Удаление пользователя**(%%) ==595 +===== (% style="color:#000000; line-height:100%" %)**Удаление пользователя**(%%) ===== 586 586 ))) 587 587 588 588 (% class="box errormessage" %) ... ... @@ -604,10 +604,10 @@ 604 604 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 605 605 606 606 607 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел: **Транспортные средства**(%%) =617 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Транспортные средства**(%%) ==== 608 608 609 609 610 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==620 +===== (% style="color:#000000; line-height:100%" %)**Получение информации об объекте**(%%) ===== 611 611 612 612 (% class="box infomessage" %) 613 613 ((( ... ... @@ -678,7 +678,7 @@ 678 678 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 679 679 680 680 681 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==691 +===== (% style="color:#000000; line-height:100%" %)**Добавление объекта**(%%) ===== 682 682 683 683 (% class="box successmessage" %) 684 684 ((( ... ... @@ -799,7 +799,7 @@ 799 799 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 800 800 801 801 802 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==812 +===== (% style="color:#000000; line-height:100%" %)**Получение параметров объектов**(%%) ===== 803 803 804 804 (% class="box successmessage" %) 805 805 ((( ... ... @@ -882,7 +882,7 @@ 882 882 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 883 883 884 884 885 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==895 +===== (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(%%) ===== 886 886 887 887 (% class="box successmessage" %) 888 888 ((( ... ... @@ -929,7 +929,7 @@ 929 929 (% style="color:#000000" %) } 930 930 931 931 932 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==942 +===== (% style="color:#000000; line-height:100%" %)**Редактирование объекта**(%%) ===== 933 933 934 934 (% class="box warningmessage" %) 935 935 ((( ... ... @@ -1059,7 +1059,7 @@ 1059 1059 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1060 1060 1061 1061 1062 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==1072 +===== (% style="color:#000000; line-height:100%" %)**Удаление объекта**(%%) ===== 1063 1063 1064 1064 (% class="box errormessage" %) 1065 1065 ((( ... ... @@ -1083,7 +1083,7 @@ 1083 1083 (% style="color:#000000; font-size:14pt" %)Раздел: **Устройства** 1084 1084 1085 1085 1086 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==1096 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств**(%%) ===== 1087 1087 1088 1088 (% class="box infomessage" %) 1089 1089 ((( ... ... @@ -1109,10 +1109,10 @@ 1109 1109 (% style="color:#000000" %)} 1110 1110 1111 1111 1112 -= (% style="color:#000000; font-size:1 8.6667pt" %)Раздел: **Датчики**(%%) =1122 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Датчики**(%%) ==== 1113 1113 1114 1114 1115 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==1125 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков**(%%) ===== 1116 1116 1117 1117 (% class="box infomessage" %) 1118 1118 (((