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:18.6667px" %)**Действующие ограничения**(%%) ==8 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 9 9 10 10 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 ... ... @@ -15,12 +15,10 @@ 15 15 16 16 (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 17 18 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 18 18 19 -== ==(% style="color:#000000; font-size:14pt" %)Раздел:**Авторизация**(%%) ====20 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 20 20 21 - 22 -===== (% style="color:#000000; line-height:100%" %)**Авторизация**(%%) ===== 23 - 24 24 (% class="box infomessage" %) 25 25 ((( 26 26 (% lang="en-US" %)**POST /api/v3/auth/login** ... ... @@ -40,8 +40,8 @@ 40 40 "login": "testuser", 41 41 "password": "testuser" 42 42 }(%%) 43 - 44 44 42 + 45 45 (% style="color:#000000" %)**Ответ:** 46 46 47 47 (% lang="en-US" %) ... ... @@ -56,9 +56,8 @@ 56 56 57 57 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 58 58 57 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 -===== (% style="color:#000000; line-height:100%" %)**Проверка авторизации**(%%) ===== 61 - 62 62 (% class="box infomessage" %) 63 63 ((( 64 64 (% lang="en-US" %)**GET /api/v3/auth/check** ... ... @@ -75,12 +75,10 @@ 75 75 (% lang="en-US" %) 76 76 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 77 77 75 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 78 78 79 -== ==(% style="color:#000000; font-size:14pt" %)Раздел:**Клиенты**(%%) ====77 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) == 80 80 81 - 82 -===== (% style="color:#000000" %)**Получение основных параметров клиента**(%%) ===== 83 - 84 84 (% class="box infomessage" %) 85 85 ((( 86 86 (% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** ... ... @@ -113,9 +113,8 @@ 113 113 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 114 114 } 115 115 111 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 116 116 117 -===== **Добавление клиента** ===== 118 - 119 119 (% class="box successmessage" %) 120 120 ((( 121 121 **POST /api/v3/agents ** ... ... @@ -175,9 +175,8 @@ 175 175 "bankKS": "string" ~/~/ корр. счёт 176 176 } 177 177 172 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 178 178 179 -===== **Редактирование клиента** ===== 180 - 181 181 (% class="box warningmessage" %) 182 182 ((( 183 183 **PUT /api/v3/agents** ... ... @@ -239,9 +239,8 @@ 239 239 "bankKS": "string" ~/~/ корр. счёт 240 240 } 241 241 235 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 242 242 243 -===== **Удаление клиента** ===== 244 - 245 245 (% class="box errormessage" %) 246 246 ((( 247 247 **DELETE /api/v3/agents/{clientId}** ... ... @@ -259,12 +259,10 @@ 259 259 260 260 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 261 261 254 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 262 262 263 -== ==(% style="color:#000000; font-size:14pt" %)Раздел:**Пользователи**(%%) ====256 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 264 264 265 - 266 -===== (% style="color:#000000; line-height:100%" %)**Добавление пользователя**(%%) ===== 267 - 268 268 (% class="box successmessage" %) 269 269 ((( 270 270 (% lang="en-US" %)**POST /api/v3/users** ... ... @@ -328,9 +328,8 @@ 328 328 (% style="text-align:left" %) 329 329 (% style="color:#000000; font-weight:normal" %)} 330 330 321 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 331 331 332 -===== (% style="color:#000000; line-height:100%" %)**Получение списка пользователей**(%%) ===== 333 - 334 334 (% class="box successmessage" %) 335 335 ((( 336 336 (% lang="en-US" %)**POST /api/v3/users/find** ... ... @@ -377,9 +377,8 @@ 377 377 378 378 (% style="color:#000000" %)} 379 379 369 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 380 380 381 -===== (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе**(%%) ===== 382 - 383 383 (% class="box successmessage" %) 384 384 ((( 385 385 (% lang="en-US" %)**GET /api/v3/users/{GUID}** ... ... @@ -427,9 +427,8 @@ 427 427 ))) 428 428 ))) 429 429 418 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 430 430 431 -===== (% style="color:#000000; line-height:100%" %)**Редактирование пользователя**(%%) ===== 432 - 433 433 (% class="box warningmessage" %) 434 434 ((( 435 435 (% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -500,9 +500,8 @@ 500 500 (% lang="en-US" style="text-align:left" %) 501 501 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 502 502 490 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 503 503 504 -===== (% style="color:#000000" %)**Изменение статуса пользователя**(%%) ===== 505 - 506 506 (% class="box warningmessage" %) 507 507 ((( 508 508 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** ... ... @@ -531,9 +531,8 @@ 531 531 (% style="text-align:left" %) 532 532 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 533 533 520 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 534 534 535 -===== **Блокировка пользователей** ===== 536 - 537 537 (% class="box warningmessage" %) 538 538 ((( 539 539 **POST /api/v3/users/disable** ... ... @@ -554,9 +554,8 @@ 554 554 555 555 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 556 556 542 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 557 557 558 -===== **Разблокировка пользователей** ===== 559 - 560 560 (% class="box warningmessage" %) 561 561 ((( 562 562 **POST /api/v3/users/enable** ... ... @@ -590,11 +590,10 @@ 590 590 } 591 591 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 592 592 "users" - массив id пользователей, которых не удалось включить или отключить. 593 - 594 - 595 -===== (% style="color:#000000; line-height:100%" %)**Удаление пользователя**(%%) ===== 596 596 ))) 597 597 579 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 580 + 598 598 (% class="box errormessage" %) 599 599 ((( 600 600 (% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -614,10 +614,10 @@ 614 614 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 615 615 616 616 617 -= ===(% style="color:#000000; font-size:14pt" %)Раздел: **Транспортные средства**(%%) ====600 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 618 618 619 619 620 -== ===(% style="color:#000000;line-height:100%" %)**Получение информации об объекте**(%%) =====603 +== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) == 621 621 622 622 (% class="box infomessage" %) 623 623 ((( ... ... @@ -688,7 +688,7 @@ 688 688 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 689 689 690 690 691 -== ===(% style="color:#000000;line-height:100%" %)**Добавление объекта**(%%) =====674 +== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) == 692 692 693 693 (% class="box successmessage" %) 694 694 ((( ... ... @@ -809,7 +809,7 @@ 809 809 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 810 810 811 811 812 -== ===(% style="color:#000000;line-height:100%" %)**Получение параметров объектов**(%%) =====795 +== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) == 813 813 814 814 (% class="box successmessage" %) 815 815 ((( ... ... @@ -892,7 +892,7 @@ 892 892 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 893 893 894 894 895 -== ===(% style="color:#000000;line-height:100%" %)**Изменение статуса объекта**(%%) =====878 +== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) == 896 896 897 897 (% class="box successmessage" %) 898 898 ((( ... ... @@ -939,7 +939,7 @@ 939 939 (% style="color:#000000" %) } 940 940 941 941 942 -== ===(% style="color:#000000;line-height:100%" %)**Редактирование объекта**(%%) =====925 +== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) == 943 943 944 944 (% class="box warningmessage" %) 945 945 ((( ... ... @@ -1069,7 +1069,7 @@ 1069 1069 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1070 1070 1071 1071 1072 -== ===(% style="color:#000000;line-height:100%" %)**Удаление объекта**(%%) =====1055 +== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) == 1073 1073 1074 1074 (% class="box errormessage" %) 1075 1075 ((( ... ... @@ -1093,7 +1093,7 @@ 1093 1093 (% style="color:#000000; font-size:14pt" %)Раздел: **Устройства** 1094 1094 1095 1095 1096 -== ===(% style="color:#000000;line-height:100%" %)**Получение списка типов устройств**(%%) =====1079 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) == 1097 1097 1098 1098 (% class="box infomessage" %) 1099 1099 ((( ... ... @@ -1119,10 +1119,10 @@ 1119 1119 (% style="color:#000000" %)} 1120 1120 1121 1121 1122 -= ===(% style="color:#000000; font-size:14pt" %)Раздел: **Датчики**(%%) ====1105 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) = 1123 1123 1124 1124 1125 -== ===(% style="color:#000000;line-height:100%" %)**Получение списка типов датчиков**(%%) =====1108 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) == 1126 1126 1127 1127 (% class="box infomessage" %) 1128 1128 (((