Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.13 >
edited by Илья Крайнов
on 2022/11/24 13:40
To version < 75.1 >
edited by Илья Крайнов
on 2023/03/14 11:29
>
Change comment: There is no comment for this version

Summary

Details

Icon 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" %)**Ответ:**
... ... @@ -74,15 +74,57 @@
74 74  
75 75  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
76 76  
77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
78 78  
79 79  (% class="box infomessage" %)
80 80  (((
81 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
82 82  )))
83 83  
84 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 85  
87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 +
89 +(% style="color:#000000" %)Метод запроса: **GET**
90 +
91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
92 +
93 +Запрос должен содержать данные параметра "**agentId**"
94 +
95 +(% style="color:#000000" %)Ответ:
96 +
97 +{
98 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 + "isForeign": true/false, ~/~/ Иностранный контрагент
105 + "district": "string", ~/~/ округ
106 + "region": "string", ~/~/ регион
107 + "city": "string", ~/~/ город
108 + "inn": "string", ~/~/ ИНН клиента
109 + "kpp": "string", ~/~/ КПП клиента
110 + "address": "string", ~/~/ юридический адрес
111 + "addressFact": "string", ~/~/ фактический адрес
112 + "email": "string", ~/~/ почта
113 + "director": "string", ~/~/ ФИО руководителя
114 + "bankName": "string", ~/~/ Банк
115 + "bankBIK": "string", ~/~/ БИК
116 + "bankRS": "string", ~/~/ Номер счета
117 + "bankKS": "string" ~/~/ Корр. счет
118 + }
119 +
120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 +
122 +(% class="box infomessage" %)
123 +(((
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
125 +)))
126 +
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 +
86 86  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
87 87  
88 88  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -89,24 +89,40 @@
89 89  
90 90  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
91 91  
92 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
93 93  
94 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
95 95  
96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
97 97  
98 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
99 99  
100 100  (% style="color:#000000" %)Ответ:
101 101  
102 -(% style="color:#000000" %){
103 - "agentId": "", ~/~/ идентификатор клиента
104 - "parentId": "", ~/~/ идентификатор клиента-родителя
105 - "name": "", ~/~/ наименование клиента
106 - "fullName": "", ~/~/ полное наименование клиента
107 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
108 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
109 -}
147 +{
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
154 + "isForeign": true/false, ~/~/ Иностранный контрагент
155 + "district": "string", ~/~/ округ
156 + "region": "string", ~/~/ регион
157 + "city": "string", ~/~/ город
158 + "inn": "string", ~/~/ ИНН клиента
159 + "kpp": "string", ~/~/ КПП клиента
160 + "address": "string", ~/~/ юридический адрес
161 + "addressFact": "string", ~/~/ фактический адрес
162 + "email": "string", ~/~/ почта
163 + "director": "string", ~/~/ ФИО руководителя
164 + "bankName": "string", ~/~/ Банк
165 + "bankBIK": "string", ~/~/ БИК
166 + "bankRS": "string", ~/~/ Номер счета
167 + "bankKS": "string" ~/~/ Корр. счет
168 + }
110 110  
111 111  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
112 112  
... ... @@ -368,7 +368,7 @@
368 368  
369 369  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
370 370  
371 -(% class="box successmessage" %)
430 +(% class="box infomessage" %)
372 372  (((
373 373  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
374 374  )))
... ... @@ -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  
660 +== (% 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  
730 +== (% 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  
850 +== (% 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  
932 +== (% 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  
978 +== (% 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  
1107 +== (% 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  
1127 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1075 1075  
1076 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1129 +== (% 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  
1154 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1104 1104  
1105 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1156 +== (% 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: Токен авторизации
1169 +(% 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  
1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1134 1134  
1184 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1185 +
1186 +(% class="box infomessage" style="text-align: left;" %)
1187 +(((
1188 +**POST /api/v3/terminalMessages/count**
1189 +)))
1190 +
1191 +(% style="text-align: left;" %)
1192 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1193 +
1194 +(% style="text-align: left;" %)
1195 +Метод запроса **POST**
1196 +
1197 +(% style="text-align: left;" %)
1198 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1199 +
1200 +(% style="text-align: left;" %)
1201 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1202 +
1203 +(% style="text-align: left;" %)
1204 +{
1205 + "objectIds": [
1206 + id ~/~/ здесь передается список идентификаторов объектов
1207 + ],
1208 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1209 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1210 +}
1211 +
1212 +(% style="text-align: left;" %)
1213 +Ответ:
1214 +
1215 +(% style="text-align: left;" %)
1216 +[
1217 + {
1218 + "id": 0, ~/~/ идентификатор объекта
1219 + "count": 0 ~/~/ количество сообщений за период
1220 + }
1221 +]
1222 +
1223 +
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]] **

Меню

ГЛОНАССSoft wiki - 2024 г.