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

Summary

Details

Icon Page properties
Content
... ... @@ -1,30 +1,24 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -**Содержание страницы:**
4 -)))
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
5 5  
4 +
6 6  {{toc/}}
7 7  
8 8  
9 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
8 +=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
10 10  
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 +
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 +==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
18 18  
19 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
20 +===== (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**(%%) =====
22 22  
23 -(% class="box infomessage" %)
24 -(((
25 -(% lang="en-US" %)**POST /api/v3/auth/login**
26 -)))
27 -
28 28  (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}
35 +}(%%)
36 +
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,14 +55,13 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
61 61  (((
62 -(% lang="en-US" %)**GET /api/v3/auth/check**
55 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
58 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -73,58 +73,18 @@
73 73  (% lang="en-US" %)
74 74  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
75 75  
76 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 -
80 -(% class="box infomessage" %)
70 +(% class="box" style="text-align: center;" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
72 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
86 -
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 122  (% class="box infomessage" %)
123 123  (((
124 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
77 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
125 125  )))
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
80 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 128  
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
... ... @@ -132,33 +132,29 @@
132 132  
133 133  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
88 +(% style="color:#000000" %)Метод запроса: **GET**
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
90 +(% 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>
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
92 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
94 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 144  
145 145  (% style="color:#000000" %)Ответ:
146 146  
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 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
98 +(% style="color:#000000" %){
99 + "agentId": "", ~/~/ идентификатор клиента
100 + "parentId": "", ~/~/ идентификатор клиента-родителя
101 + "name": "", ~/~/ наименование клиента
102 + "fullName": "", ~/~/ полное наименование клиента
103 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
104 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
155 155  }
156 156  
157 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
160 160  (((
161 -**POST /api/v3/agents **
110 +**Добавление клиента — POST /api/v3/agents **
162 162  )))
163 163  
164 164  Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -175,7 +175,6 @@
175 175   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 179   "isForeign": true, ~/~/ иностранный контрагент
180 180   "district": "string", ~/~/ округ
181 181   "region": "string", ~/~/ регион
... ... @@ -200,7 +200,6 @@
200 200   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 201   "name": "string", ~/~/ имя
202 202   "fullName": "string", ~/~/ полное наименование
203 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 204   "isForeign": true, ~/~/ иностранный контрагент
205 205   "district": "string", ~/~/ округ
206 206   "region": "string", ~/~/ регион
... ... @@ -217,11 +217,10 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
220 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
223 223  (((
224 -**PUT /api/v3/agents**
170 +**Редактирование клиента — PUT /api/v3/agents**
225 225  )))
226 226  
227 227  Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -240,7 +240,6 @@
240 240   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 241   "name": "string", ~/~/ имя
242 242   "fullName": "string", ~/~/ полное наименование
243 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 244   "isForeign": true, ~/~/ иностранный контрагент
245 245   "district": "string", ~/~/ округ
246 246   "region": "string", ~/~/ регион
... ... @@ -281,13 +281,13 @@
281 281   "bankKS": "string" ~/~/ корр. счёт
282 282  }
283 283  
284 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
285 285  
286 286  (% class="box errormessage" %)
287 287  (((
288 -**DELETE /api/v3/agents/{clientId}**
232 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
289 289  )))
290 290  
235 +
291 291  Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
292 292  
293 293  Метод запроса: **DELETE**
... ... @@ -300,16 +300,19 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
303 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
306 306  
250 +(% class="box" style="text-align: center;" %)
251 +(((
252 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
253 +)))
254 +
307 307  (% class="box successmessage" %)
308 308  (((
309 -(% lang="en-US" %)**POST /api/v3/users**
257 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
310 310  )))
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
260 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
313 313  
314 314  (% style="color:#000000" %)Метод запроса: **POST**
315 315  
... ... @@ -367,14 +367,13 @@
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)}
369 369  
370 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
371 371  
372 -(% class="box infomessage" %)
319 +(% class="box successmessage" %)
373 373  (((
374 -(% lang="en-US" %)**POST /api/v3/users/find**
321 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
375 375  )))
376 376  
377 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
324 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
378 378  
379 379  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
380 380  
... ... @@ -415,14 +415,13 @@
415 415  
416 416  (% style="color:#000000" %)}
417 417  
418 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
419 419  
420 -(% class="box infomessage" %)
366 +(% class="box successmessage" %)
421 421  (((
422 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
368 +(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
423 423  )))
424 424  
425 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
371 +(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
426 426  
427 427  (% style="color:#000000" %)Метод запроса: **GET**
428 428  
... ... @@ -449,11 +449,8 @@
449 449   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
450 450   "description": "", ~/~/ Описание
451 451   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
452 - "doubleAuth":
453 - {
454 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
455 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
456 - },
398 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
399 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
457 457   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
458 458   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
459 459   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -467,14 +467,13 @@
467 467  )))
468 468  )))
469 469  
470 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
471 471  
472 472  (% class="box warningmessage" %)
473 473  (((
474 -(% lang="en-US" %)**PUT /api/v3/users**
416 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
475 475  )))
476 476  
477 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
419 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
478 478  
479 479  (% style="color:#000000" %)Метод запроса: **PUT**
480 480  
... ... @@ -482,6 +482,8 @@
482 482  
483 483  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
484 484  
427 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
428 +
485 485  (% lang="en-US" style="text-align:left" %)
486 486  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
487 487  
... ... @@ -496,9 +496,7 @@
496 496   "phone": "" , ~/~/ телефон
497 497   "organization": "" , ~/~/ организация
498 498   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
499 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
500 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
501 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
443 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
502 502   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
503 503  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
504 504   "isEnabled": "" , ~/~/ признак включения
... ... @@ -505,12 +505,9 @@
505 505   "parentId": "" , ~/~/ Guid родительского агента
506 506   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
507 507   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
508 - "doubleAuth":
509 - {
510 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
511 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
512 - },
513 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
450 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
451 + "kind": "" , ~/~/ тип аутентификации
452 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
514 514   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
515 515  
516 516  (% lang="en-US" style="text-align:left" %)
... ... @@ -536,12 +536,8 @@
536 536   "isEnabled": "" , ~/~/ признак включения
537 537   "parentId": "" , ~/~/ Guid родительского агента
538 538   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
539 - "doubleAuth":
540 - {
541 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
542 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
543 - },
544 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
478 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
479 + "kind": "" , ~/~/ тип аутентификации
545 545   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
546 546   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
547 547  
... ... @@ -548,14 +548,13 @@
548 548  (% lang="en-US" style="text-align:left" %)
549 549  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
550 550  
551 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
552 552  
553 553  (% class="box warningmessage" %)
554 554  (((
555 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
489 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
556 556  )))
557 557  
558 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
492 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
559 559  
560 560  (% style="color:#000000" %)Метод запроса: **PUT**
561 561  
... ... @@ -578,11 +578,10 @@
578 578  (% style="text-align:left" %)
579 579  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
580 580  
581 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
582 582  
583 583  (% class="box warningmessage" %)
584 584  (((
585 -**POST /api/v3/users/disable**
518 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
586 586  )))
587 587  
588 588  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -600,11 +600,10 @@
600 600  
601 601  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
602 602  
603 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
604 604  
605 605  (% class="box warningmessage" %)
606 606  (((
607 -**POST /api/v3/users/enable**
539 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
608 608  )))
609 609  
610 610  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -635,16 +635,15 @@
635 635  }
636 636  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
637 637  "users" - массив id пользователей, которых не удалось включить или отключить.
570 +
638 638  )))
639 639  
640 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
641 -
642 642  (% class="box errormessage" %)
643 643  (((
644 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
575 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
645 645  )))
646 646  
647 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
578 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
648 648  
649 649  (% style="color:#000000" %)Метод запроса: **DELETE**
650 650  
... ... @@ -657,18 +657,20 @@
657 657  (% style="text-align:left" %)
658 658  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
659 659  
660 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
661 661  
662 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
592 +(% class="box" style="text-align: center;" %)
593 +(((
594 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
595 +)))
663 663  
664 664  (% class="box infomessage" %)
665 665  (((
666 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
599 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
667 667  )))
668 668  
669 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
602 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
670 670  
671 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
604 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
672 672  
673 673  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
674 674  
... ... @@ -703,8 +703,6 @@
703 703   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
704 704   "mileage": "", ~/~/ Пробег по нормам в метрах
705 705   "motohours": "" ~/~/ Моточасы по нормам, в секундах
706 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
707 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
708 708   },
709 709   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
710 710   {
... ... @@ -731,14 +731,13 @@
731 731  (% style="text-align:left" %)
732 732  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
733 733  
734 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
735 735  
736 736  (% class="box successmessage" %)
737 737  (((
738 -(% lang="en-US" %)**POST /api/v3/vehicles**
668 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
739 739  )))
740 740  
741 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
671 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
742 742  
743 743  (% style="color:#000000" %)Метод запроса: **POST**
744 744  
... ... @@ -851,16 +851,15 @@
851 851  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
852 852  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
853 853  
854 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
855 855  
856 -(% class="box infomessage" %)
785 +(% class="box successmessage" %)
857 857  (((
858 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
787 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
859 859  )))
860 860  
861 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
790 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
862 862  
863 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
792 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
864 864  
865 865  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
866 866  
... ... @@ -897,7 +897,7 @@
897 897   "customFields": null ~/~/ значение любого из произвольных полей ТС
898 898  }
899 899  
900 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
829 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
901 901  
902 902  (% style="color:#000000" %)Ответ:
903 903  
... ... @@ -933,14 +933,13 @@
933 933  
934 934  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
935 935  
936 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
937 937  
938 938  (% class="box successmessage" %)
939 939  (((
940 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
868 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
941 941  )))
942 942  
943 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
871 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
944 944  
945 945  (% style="color:#000000" %)Метод запроса: **POST**
946 946  
... ... @@ -979,14 +979,13 @@
979 979  (% style="text-align:left" %)
980 980  (% style="color:#000000" %) }
981 981  
982 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
983 983  
984 984  (% class="box warningmessage" %)
985 985  (((
986 -(% lang="en-US" %)**PUT /api/v3/vehicles**
913 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
987 987  )))
988 988  
989 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
916 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
990 990  
991 991  (% style="color:#000000" %)Метод запроса: **PUT**
992 992  
... ... @@ -1108,14 +1108,13 @@
1108 1108  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1109 1109  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1110 1110  
1111 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1112 1112  
1113 1113  (% class="box errormessage" %)
1114 1114  (((
1115 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1041 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1116 1116  )))
1117 1117  
1118 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1044 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1119 1119  
1120 1120  (% style="color:#000000" %)Метод запроса: **DELETE**
1121 1121  
... ... @@ -1128,16 +1128,18 @@
1128 1128  (% style="text-align:left" %)
1129 1129  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1130 1130  
1131 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1132 1132  
1133 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1058 +(% class="box" lang="en-US" style="text-align: center;" %)
1059 +(((
1060 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1061 +)))
1134 1134  
1135 1135  (% class="box infomessage" %)
1136 1136  (((
1137 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1065 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1138 1138  )))
1139 1139  
1140 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1068 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1141 1141  
1142 1142  (% style="color:#000000" %)Метод запроса: **GET**
1143 1143  
... ... @@ -1155,22 +1155,24 @@
1155 1155  (% style="text-align:left" %)
1156 1156  (% style="color:#000000" %)}
1157 1157  
1158 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1159 1159  
1160 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1087 +(% class="box" style="text-align: center;" %)
1088 +(((
1089 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1090 +)))
1161 1161  
1162 1162  (% class="box infomessage" %)
1163 1163  (((
1164 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1094 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1165 1165  )))
1166 1166  
1167 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1097 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1168 1168  
1169 1169  (% style="color:#000000" %)Метод запроса: **GET**
1170 1170  
1171 1171  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1172 1172  
1173 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1103 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1174 1174  
1175 1175  (% style="color:#000000" %)Ответ:
1176 1176  
... ... @@ -1183,48 +1183,7 @@
1183 1183  (% style="text-align:left" %)
1184 1184  (% style="color:#000000" %)}
1185 1185  
1186 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1187 1187  
1188 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1189 -
1190 -(% class="box infomessage" style="text-align: left;" %)
1191 -(((
1192 -**POST /api/v3/terminalMessages/count**
1193 -)))
1194 -
1195 -(% style="text-align: left;" %)
1196 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1197 -
1198 -(% style="text-align: left;" %)
1199 -Метод запроса **POST**
1200 -
1201 -(% style="text-align: left;" %)
1202 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1203 -
1204 -(% style="text-align: left;" %)
1205 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1206 -
1207 -(% style="text-align: left;" %)
1208 -{
1209 - "vehicleIds": [
1210 - id ~/~/ здесь передается список идентификаторов объектов
1211 - ],
1212 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1213 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1214 -}
1215 -
1216 -(% style="text-align: left;" %)
1217 -Ответ:
1218 -
1219 -(% style="text-align: left;" %)
1220 -[
1221 - {
1222 - "vehicleId": 0, ~/~/ идентификатор объекта
1223 - "count": 0 ~/~/ количество сообщений за период
1224 - }
1225 -]
1226 -
1227 -
1228 1228  (% class="box" lang="en-US" style="text-align: center;" %)
1229 1229  (((
1230 1230  (% 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 г.