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** ... ... @@ -318,8 +318,9 @@ 318 318 (% style="text-align:left" %) 319 319 (% style="color:#000000; font-weight:normal" %)} 320 320 321 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 322 322 332 +===== (% style="color:#000000; line-height:100%" %)**Получение списка пользователей**(%%) ===== 333 + 323 323 (% class="box successmessage" %) 324 324 ((( 325 325 (% lang="en-US" %)**POST /api/v3/users/find** ... ... @@ -366,8 +366,9 @@ 366 366 367 367 (% style="color:#000000" %)} 368 368 369 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 370 370 381 +===== (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе**(%%) ===== 382 + 371 371 (% class="box successmessage" %) 372 372 ((( 373 373 (% lang="en-US" %)**GET /api/v3/users/{GUID}** ... ... @@ -415,8 +415,9 @@ 415 415 ))) 416 416 ))) 417 417 418 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 419 419 431 +===== (% style="color:#000000; line-height:100%" %)**Редактирование пользователя**(%%) ===== 432 + 420 420 (% class="box warningmessage" %) 421 421 ((( 422 422 (% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -487,8 +487,9 @@ 487 487 (% lang="en-US" style="text-align:left" %) 488 488 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 489 489 490 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 491 491 504 +===== (% style="color:#000000" %)**Изменение статуса пользователя**(%%) ===== 505 + 492 492 (% class="box warningmessage" %) 493 493 ((( 494 494 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** ... ... @@ -517,8 +517,9 @@ 517 517 (% style="text-align:left" %) 518 518 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 519 519 520 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 521 521 535 +===== **Блокировка пользователей** ===== 536 + 522 522 (% class="box warningmessage" %) 523 523 ((( 524 524 **POST /api/v3/users/disable** ... ... @@ -540,7 +540,7 @@ 540 540 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 541 541 542 542 543 -== (% style="color:#000000;font-size:16px" %)**Разблокировка пользователей**(%%)==558 +===== **Разблокировка пользователей** ===== 544 544 545 545 (% class="box warningmessage" %) 546 546 ((( ... ... @@ -575,10 +575,11 @@ 575 575 } 576 576 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 577 577 "users" - массив id пользователей, которых не удалось включить или отключить. 593 + 594 + 595 +===== (% style="color:#000000; line-height:100%" %)**Удаление пользователя**(%%) ===== 578 578 ))) 579 579 580 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 581 - 582 582 (% class="box errormessage" %) 583 583 ((( 584 584 (% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -598,10 +598,10 @@ 598 598 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 599 599 600 600 601 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел: **Транспортные средства**(%%) =617 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Транспортные средства**(%%) ==== 602 602 603 603 604 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==620 +===== (% style="color:#000000; line-height:100%" %)**Получение информации об объекте**(%%) ===== 605 605 606 606 (% class="box infomessage" %) 607 607 ((( ... ... @@ -672,7 +672,7 @@ 672 672 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 673 673 674 674 675 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==691 +===== (% style="color:#000000; line-height:100%" %)**Добавление объекта**(%%) ===== 676 676 677 677 (% class="box successmessage" %) 678 678 ((( ... ... @@ -793,7 +793,7 @@ 793 793 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 794 794 795 795 796 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==812 +===== (% style="color:#000000; line-height:100%" %)**Получение параметров объектов**(%%) ===== 797 797 798 798 (% class="box successmessage" %) 799 799 ((( ... ... @@ -876,7 +876,7 @@ 876 876 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 877 877 878 878 879 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==895 +===== (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(%%) ===== 880 880 881 881 (% class="box successmessage" %) 882 882 ((( ... ... @@ -923,7 +923,7 @@ 923 923 (% style="color:#000000" %) } 924 924 925 925 926 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==942 +===== (% style="color:#000000; line-height:100%" %)**Редактирование объекта**(%%) ===== 927 927 928 928 (% class="box warningmessage" %) 929 929 ((( ... ... @@ -1053,7 +1053,7 @@ 1053 1053 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1054 1054 1055 1055 1056 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==1072 +===== (% style="color:#000000; line-height:100%" %)**Удаление объекта**(%%) ===== 1057 1057 1058 1058 (% class="box errormessage" %) 1059 1059 ((( ... ... @@ -1077,7 +1077,7 @@ 1077 1077 (% style="color:#000000; font-size:14pt" %)Раздел: **Устройства** 1078 1078 1079 1079 1080 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==1096 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств**(%%) ===== 1081 1081 1082 1082 (% class="box infomessage" %) 1083 1083 ((( ... ... @@ -1103,10 +1103,10 @@ 1103 1103 (% style="color:#000000" %)} 1104 1104 1105 1105 1106 -= (% style="color:#000000; font-size:1 8.6667pt" %)Раздел: **Датчики**(%%) =1122 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Датчики**(%%) ==== 1107 1107 1108 1108 1109 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==1125 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков**(%%) ===== 1110 1110 1111 1111 (% class="box infomessage" %) 1112 1112 (((