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" %)**Ответ:** ... ... @@ -596,12 +596,10 @@ 596 596 (% style="text-align:left" %) 597 597 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 598 598 599 - 600 600 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 601 601 602 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 602 602 603 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) == 604 - 605 605 (% class="box infomessage" %) 606 606 ((( 607 607 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -670,9 +670,8 @@ 670 670 (% style="text-align:left" %) 671 671 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 672 672 672 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 673 673 674 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) == 675 - 676 676 (% class="box successmessage" %) 677 677 ((( 678 678 (% lang="en-US" %)**POST /api/v3/vehicles** ... ... @@ -791,9 +791,8 @@ 791 791 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 792 792 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 793 793 792 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 794 794 795 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) == 796 - 797 797 (% class="box successmessage" %) 798 798 ((( 799 799 (% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -874,9 +874,8 @@ 874 874 875 875 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 876 876 874 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 877 877 878 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) == 879 - 880 880 (% class="box successmessage" %) 881 881 ((( 882 882 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -921,9 +921,8 @@ 921 921 (% style="text-align:left" %) 922 922 (% style="color:#000000" %) } 923 923 920 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 924 924 925 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) == 926 - 927 927 (% class="box warningmessage" %) 928 928 ((( 929 929 (% lang="en-US" %)**PUT /api/v3/vehicles** ... ... @@ -1051,9 +1051,8 @@ 1051 1051 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1052 1052 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1053 1053 1049 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1054 1054 1055 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) == 1056 - 1057 1057 (% class="box errormessage" %) 1058 1058 ((( 1059 1059 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -1072,12 +1072,10 @@ 1072 1072 (% style="text-align:left" %) 1073 1073 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1074 1074 1069 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1075 1075 1076 -(% style="color:#000000; font-size:1 4pt" %)Раздел:**Устройства**1071 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1077 1077 1078 - 1079 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) == 1080 - 1081 1081 (% class="box infomessage" %) 1082 1082 ((( 1083 1083 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** ... ... @@ -1101,12 +1101,10 @@ 1101 1101 (% style="text-align:left" %) 1102 1102 (% style="color:#000000" %)} 1103 1103 1096 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1104 1104 1105 -= (% style="color:#000000; font-size:1 8.6667pt" %)Раздел:**Датчики**(%%) =1098 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1106 1106 1107 - 1108 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) == 1109 - 1110 1110 (% class="box infomessage" %) 1111 1111 ((( 1112 1112 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** ... ... @@ -1118,7 +1118,7 @@ 1118 1118 1119 1119 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1120 1120 1121 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1111 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1122 1122 1123 1123 (% style="color:#000000" %)Ответ: 1124 1124 ... ... @@ -1131,7 +1131,48 @@ 1131 1131 (% style="text-align:left" %) 1132 1132 (% style="color:#000000" %)} 1133 1133 1124 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 1134 1134 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 + 1135 1135 (% class="box" lang="en-US" style="text-align: center;" %) 1136 1136 ((( 1137 1137 (% 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]] **