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

Summary

Details

Icon Page properties
Content
... ... @@ -1,24 +1,30 @@
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 -=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
9 += (% 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  
14 14  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 -
16 16  
17 -==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
19 19  
20 -===== (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**(%%) =====
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
21 21  
23 +(% class="box infomessage" %)
24 +(((
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 +)))
27 +
22 22  (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
23 23  
24 24  (% style="color:#000000" %)Метод запроса: **POST**
... ... @@ -32,9 +32,9 @@
32 32  (% style="color:#000000" %){
33 33   "login": "testuser",
34 34   "password": "testuser"
35 -}(%%)
36 -
41 +}
37 37  
43 +
38 38  (% style="color:#000000" %)**Ответ:**
39 39  
40 40  (% lang="en-US" %)
... ... @@ -49,13 +49,14 @@
49 49  
50 50  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
51 51  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
52 52  
53 53  (% class="box infomessage" %)
54 54  (((
55 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
56 56  )))
57 57  
58 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
59 59  
60 60  (% style="color:#000000" %)Метод запроса: **GET**
61 61  
... ... @@ -66,18 +66,58 @@
66 66  (% lang="en-US" %)
67 67  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
68 68  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
69 69  
70 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
71 71  (((
72 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
73 73  )))
74 74  
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 +
75 75  (% class="box infomessage" %)
76 76  (((
77 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
78 78  )))
79 79  
80 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
81 81  
82 82  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
83 83  
... ... @@ -85,29 +85,33 @@
85 85  
86 86  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
87 87  
88 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
89 89  
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>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
91 91  
92 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
93 93  
94 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
95 95  
96 96  (% style="color:#000000" %)Ответ:
97 97  
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 - Отказ)
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 - Отказ)
105 105  }
106 106  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
107 107  
108 108  (% class="box successmessage" %)
109 109  (((
110 -**Добавление клиента — POST /api/v3/agents **
161 +**POST /api/v3/agents **
111 111  )))
112 112  
113 113  Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -124,6 +124,7 @@
124 124   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
125 125   "name": "string", ~/~/ имя
126 126   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
127 127   "isForeign": true, ~/~/ иностранный контрагент
128 128   "district": "string", ~/~/ округ
129 129   "region": "string", ~/~/ регион
... ... @@ -148,6 +148,7 @@
148 148   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
149 149   "name": "string", ~/~/ имя
150 150   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
151 151   "isForeign": true, ~/~/ иностранный контрагент
152 152   "district": "string", ~/~/ округ
153 153   "region": "string", ~/~/ регион
... ... @@ -164,10 +164,11 @@
164 164   "bankKS": "string" ~/~/ корр. счёт
165 165  }
166 166  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
167 167  
168 168  (% class="box warningmessage" %)
169 169  (((
170 -**Редактирование клиента — PUT /api/v3/agents**
224 +**PUT /api/v3/agents**
171 171  )))
172 172  
173 173  Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
... ... @@ -186,6 +186,7 @@
186 186   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
187 187   "name": "string", ~/~/ имя
188 188   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
189 189   "isForeign": true, ~/~/ иностранный контрагент
190 190   "district": "string", ~/~/ округ
191 191   "region": "string", ~/~/ регион
... ... @@ -226,13 +226,13 @@
226 226   "bankKS": "string" ~/~/ корр. счёт
227 227  }
228 228  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
229 229  
230 230  (% class="box errormessage" %)
231 231  (((
232 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
288 +**DELETE /api/v3/agents/{clientId}**
233 233  )))
234 234  
235 -
236 236  Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
237 237  
238 238  Метод запроса: **DELETE**
... ... @@ -245,19 +245,16 @@
245 245  
246 246  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
247 247  
303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
248 248  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
249 249  
250 -(% class="box" style="text-align: center;" %)
251 -(((
252 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
253 -)))
254 -
255 255  (% class="box successmessage" %)
256 256  (((
257 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
258 258  )))
259 259  
260 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
261 261  
262 262  (% style="color:#000000" %)Метод запроса: **POST**
263 263  
... ... @@ -315,13 +315,14 @@
315 315  (% style="text-align:left" %)
316 316  (% style="color:#000000; font-weight:normal" %)}
317 317  
370 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
318 318  
319 -(% class="box successmessage" %)
372 +(% class="box infomessage" %)
320 320  (((
321 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
374 +(% lang="en-US" %)**POST /api/v3/users/find**
322 322  )))
323 323  
324 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
377 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
325 325  
326 326  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
327 327  
... ... @@ -362,13 +362,14 @@
362 362  
363 363  (% style="color:#000000" %)}
364 364  
418 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
365 365  
366 -(% class="box successmessage" %)
420 +(% class="box infomessage" %)
367 367  (((
368 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
422 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
369 369  )))
370 370  
371 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
425 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
372 372  
373 373  (% style="color:#000000" %)Метод запроса: **GET**
374 374  
... ... @@ -395,8 +395,11 @@
395 395   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
396 396   "description": "", ~/~/ Описание
397 397   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
398 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
399 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
452 + "doubleAuth":
453 + {
454 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
455 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
456 + },
400 400   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
401 401   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
402 402   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -410,13 +410,14 @@
410 410  )))
411 411  )))
412 412  
470 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
413 413  
414 414  (% class="box warningmessage" %)
415 415  (((
416 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
474 +(% lang="en-US" %)**PUT /api/v3/users**
417 417  )))
418 418  
419 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
477 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
420 420  
421 421  (% style="color:#000000" %)Метод запроса: **PUT**
422 422  
... ... @@ -424,8 +424,6 @@
424 424  
425 425  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
426 426  
427 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
428 -
429 429  (% lang="en-US" style="text-align:left" %)
430 430  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
431 431  
... ... @@ -447,9 +447,11 @@
447 447   "parentId": "" , ~/~/ Guid родительского агента
448 448   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
449 449   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
450 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
451 - "kind": "" , ~/~/ тип аутентификации
452 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
506 + "doubleAuth":
507 + {
508 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
509 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
510 + },
453 453   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
454 454  
455 455  (% lang="en-US" style="text-align:left" %)
... ... @@ -475,8 +475,11 @@
475 475   "isEnabled": "" , ~/~/ признак включения
476 476   "parentId": "" , ~/~/ Guid родительского агента
477 477   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
478 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
479 - "kind": "" , ~/~/ тип аутентификации
536 + "doubleAuth":
537 + {
538 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
539 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
540 + },
480 480   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
481 481   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
482 482  
... ... @@ -483,13 +483,14 @@
483 483  (% lang="en-US" style="text-align:left" %)
484 484  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
485 485  
547 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
486 486  
487 487  (% class="box warningmessage" %)
488 488  (((
489 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
551 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
490 490  )))
491 491  
492 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
554 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
493 493  
494 494  (% style="color:#000000" %)Метод запроса: **PUT**
495 495  
... ... @@ -512,10 +512,11 @@
512 512  (% style="text-align:left" %)
513 513  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
514 514  
577 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
515 515  
516 516  (% class="box warningmessage" %)
517 517  (((
518 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
581 +**POST /api/v3/users/disable**
519 519  )))
520 520  
521 521  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -533,10 +533,11 @@
533 533  
534 534  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
535 535  
599 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
536 536  
537 537  (% class="box warningmessage" %)
538 538  (((
539 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
603 +**POST /api/v3/users/enable**
540 540  )))
541 541  
542 542  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -567,15 +567,16 @@
567 567  }
568 568  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
569 569  "users" - массив id пользователей, которых не удалось включить или отключить.
570 -
571 571  )))
572 572  
636 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
637 +
573 573  (% class="box errormessage" %)
574 574  (((
575 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
640 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
576 576  )))
577 577  
578 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
643 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
579 579  
580 580  (% style="color:#000000" %)Метод запроса: **DELETE**
581 581  
... ... @@ -588,20 +588,18 @@
588 588  (% style="text-align:left" %)
589 589  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
590 590  
656 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
591 591  
592 -(% class="box" style="text-align: center;" %)
593 -(((
594 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
595 -)))
658 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
596 596  
597 597  (% class="box infomessage" %)
598 598  (((
599 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
662 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
600 600  )))
601 601  
602 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
665 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
603 603  
604 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
667 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
605 605  
606 606  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
607 607  
... ... @@ -636,6 +636,8 @@
636 636   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
637 637   "mileage": "", ~/~/ Пробег по нормам в метрах
638 638   "motohours": "" ~/~/ Моточасы по нормам, в секундах
702 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
703 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
639 639   },
640 640   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
641 641   {
... ... @@ -662,13 +662,14 @@
662 662  (% style="text-align:left" %)
663 663  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
664 664  
730 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
665 665  
666 666  (% class="box successmessage" %)
667 667  (((
668 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
734 +(% lang="en-US" %)**POST /api/v3/vehicles**
669 669  )))
670 670  
671 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
737 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
672 672  
673 673  (% style="color:#000000" %)Метод запроса: **POST**
674 674  
... ... @@ -781,15 +781,16 @@
781 781  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
782 782  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
783 783  
850 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
784 784  
785 -(% class="box successmessage" %)
852 +(% class="box infomessage" %)
786 786  (((
787 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
854 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
788 788  )))
789 789  
790 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
857 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
791 791  
792 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
859 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
793 793  
794 794  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
795 795  
... ... @@ -826,7 +826,7 @@
826 826   "customFields": null ~/~/ значение любого из произвольных полей ТС
827 827  }
828 828  
829 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
896 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
830 830  
831 831  (% style="color:#000000" %)Ответ:
832 832  
... ... @@ -862,13 +862,14 @@
862 862  
863 863  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
864 864  
932 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
865 865  
866 866  (% class="box successmessage" %)
867 867  (((
868 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
936 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
869 869  )))
870 870  
871 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
939 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
872 872  
873 873  (% style="color:#000000" %)Метод запроса: **POST**
874 874  
... ... @@ -907,13 +907,14 @@
907 907  (% style="text-align:left" %)
908 908  (% style="color:#000000" %) }
909 909  
978 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
910 910  
911 911  (% class="box warningmessage" %)
912 912  (((
913 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
982 +(% lang="en-US" %)**PUT /api/v3/vehicles**
914 914  )))
915 915  
916 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
985 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
917 917  
918 918  (% style="color:#000000" %)Метод запроса: **PUT**
919 919  
... ... @@ -1035,13 +1035,14 @@
1035 1035  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1036 1036  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1037 1037  
1107 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1038 1038  
1039 1039  (% class="box errormessage" %)
1040 1040  (((
1041 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1111 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1042 1042  )))
1043 1043  
1044 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1114 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1045 1045  
1046 1046  (% style="color:#000000" %)Метод запроса: **DELETE**
1047 1047  
... ... @@ -1054,18 +1054,16 @@
1054 1054  (% style="text-align:left" %)
1055 1055  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1056 1056  
1127 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1057 1057  
1058 -(% class="box" lang="en-US" style="text-align: center;" %)
1059 -(((
1060 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1061 -)))
1129 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1062 1062  
1063 1063  (% class="box infomessage" %)
1064 1064  (((
1065 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1133 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1066 1066  )))
1067 1067  
1068 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1136 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1069 1069  
1070 1070  (% style="color:#000000" %)Метод запроса: **GET**
1071 1071  
... ... @@ -1083,24 +1083,22 @@
1083 1083  (% style="text-align:left" %)
1084 1084  (% style="color:#000000" %)}
1085 1085  
1154 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1086 1086  
1087 -(% class="box" style="text-align: center;" %)
1088 -(((
1089 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1090 -)))
1156 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1091 1091  
1092 1092  (% class="box infomessage" %)
1093 1093  (((
1094 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1160 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1095 1095  )))
1096 1096  
1097 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1163 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1098 1098  
1099 1099  (% style="color:#000000" %)Метод запроса: **GET**
1100 1100  
1101 1101  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1102 1102  
1103 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1104 1104  
1105 1105  (% style="color:#000000" %)Ответ:
1106 1106  
... ... @@ -1113,7 +1113,48 @@
1113 1113  (% style="text-align:left" %)
1114 1114  (% style="color:#000000" %)}
1115 1115  
1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1116 1116  
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 + "vehicleIds": [
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 + "vehicleId": 0, ~/~/ идентификатор объекта
1219 + "count": 0 ~/~/ количество сообщений за период
1220 + }
1221 +]
1222 +
1223 +
1117 1117  (% class="box" lang="en-US" style="text-align: center;" %)
1118 1118  (((
1119 1119  (% 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 г.