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,13 +1,14 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -= Описание ГЛОНАССSoft Public API 3.0 = 2 +((( 3 +**Содержание страницы:** 4 +))) 3 3 4 - 5 5 {{toc/}} 6 6 7 7 8 8 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 9 9 10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 12 12 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 13 13 ... ... @@ -37,7 +37,7 @@ 37 37 (% style="color:#000000" %){ 38 38 "login": "testuser", 39 39 "password": "testuser" 40 -} (%%)41 +} 41 41 42 42 43 43 (% style="color:#000000" %)**Ответ:** ... ... @@ -539,7 +539,6 @@ 539 539 540 540 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 541 541 542 - 543 543 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 544 544 545 545 (% class="box warningmessage" %) ... ... @@ -597,12 +597,10 @@ 597 597 (% style="text-align:left" %) 598 598 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 599 599 600 - 601 601 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 602 602 602 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 603 603 604 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) == 605 - 606 606 (% class="box infomessage" %) 607 607 ((( 608 608 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -671,9 +671,8 @@ 671 671 (% style="text-align:left" %) 672 672 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 673 673 672 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 674 674 675 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) == 676 - 677 677 (% class="box successmessage" %) 678 678 ((( 679 679 (% lang="en-US" %)**POST /api/v3/vehicles** ... ... @@ -792,9 +792,8 @@ 792 792 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 793 793 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 794 794 792 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 795 795 796 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) == 797 - 798 798 (% class="box successmessage" %) 799 799 ((( 800 800 (% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -875,9 +875,8 @@ 875 875 876 876 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 877 877 874 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 878 878 879 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) == 880 - 881 881 (% class="box successmessage" %) 882 882 ((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -922,9 +922,8 @@ 922 922 (% style="text-align:left" %) 923 923 (% style="color:#000000" %) } 924 924 920 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 925 925 926 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) == 927 - 928 928 (% class="box warningmessage" %) 929 929 ((( 930 930 (% lang="en-US" %)**PUT /api/v3/vehicles** ... ... @@ -1052,9 +1052,8 @@ 1052 1052 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1053 1053 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1054 1054 1049 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1055 1055 1056 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) == 1057 - 1058 1058 (% class="box errormessage" %) 1059 1059 ((( 1060 1060 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -1073,12 +1073,10 @@ 1073 1073 (% style="text-align:left" %) 1074 1074 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1075 1075 1069 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1076 1076 1077 -(% style="color:#000000; font-size:1 4pt" %)Раздел:**Устройства**1071 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1078 1078 1079 - 1080 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) == 1081 - 1082 1082 (% class="box infomessage" %) 1083 1083 ((( 1084 1084 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** ... ... @@ -1102,12 +1102,10 @@ 1102 1102 (% style="text-align:left" %) 1103 1103 (% style="color:#000000" %)} 1104 1104 1096 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1105 1105 1106 -= (% style="color:#000000; font-size:1 8.6667pt" %)Раздел:**Датчики**(%%) =1098 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1107 1107 1108 - 1109 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) == 1110 - 1111 1111 (% class="box infomessage" %) 1112 1112 ((( 1113 1113 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** ... ... @@ -1119,7 +1119,7 @@ 1119 1119 1120 1120 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1121 1121 1122 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1111 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1123 1123 1124 1124 (% style="color:#000000" %)Ответ: 1125 1125 ... ... @@ -1132,7 +1132,48 @@ 1132 1132 (% style="text-align:left" %) 1133 1133 (% style="color:#000000" %)} 1134 1134 1124 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 1135 1135 1126 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта (кол-во сообщений за период)**(%%) == 1127 + 1128 +(% class="box infomessage" style="text-align: left;" %) 1129 +((( 1130 +**POST /api/v3/terminalMessages/count** 1131 +))) 1132 + 1133 +(% style="text-align: left;" %) 1134 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1135 + 1136 +(% style="text-align: left;" %) 1137 +Метод запроса **POST** 1138 + 1139 +(% style="text-align: left;" %) 1140 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1141 + 1142 +(% style="text-align: left;" %) 1143 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1144 + 1145 +(% style="text-align: left;" %) 1146 +{ 1147 + "objectIds": [ 1148 + id ~/~/ здесь передается список идентификаторов объектов 1149 + ], 1150 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1151 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1152 +} 1153 + 1154 +(% style="text-align: left;" %) 1155 +Ответ: 1156 + 1157 +(% style="text-align: left;" %) 1158 +[ 1159 + { 1160 + "id": 0, ~/~/ идентификатор объекта 1161 + "count": 0 ~/~/ количество сообщений за период 1162 + } 1163 +] 1164 + 1165 + 1136 1136 (% class="box" lang="en-US" style="text-align: center;" %) 1137 1137 ((( 1138 1138 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **