Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.6 >
edited by Илья Крайнов
on 2022/11/24 13:32
To version < 79.1 >
edited by Илья Крайнов
on 2023/03/29 12:22
>
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  
... ... @@ -15,10 +15,8 @@
15 15  
16 16  (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 17  
18 -
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -
22 22  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
23 23  
24 24  (% class="box infomessage" %)
... ... @@ -39,9 +39,9 @@
39 39  (% style="color:#000000" %){
40 40   "login": "testuser",
41 41   "password": "testuser"
42 -}(%%)
43 -
41 +}
44 44  
43 +
45 45  (% style="color:#000000" %)**Ответ:**
46 46  
47 47  (% lang="en-US" %)
... ... @@ -56,7 +56,6 @@
56 56  
57 57  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
58 58  
59 -
60 60  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
61 61  
62 62  (% class="box infomessage" %)
... ... @@ -75,18 +75,58 @@
75 75  (% lang="en-US" %)
76 76  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
77 77  
78 -
79 79  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
80 80  
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
81 81  
82 -== (% style="color:#000000" %)**Получение основных параметров клиента**(%%) ==
80 +(% class="box infomessage" %)
81 +(((
82 +**GET api/v3/agents/{id}**
83 +)))
83 83  
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": "", ~/~/ идентификатор клиента    (%%)
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 +
84 84  (% class="box infomessage" %)
85 85  (((
86 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
87 87  )))
88 88  
89 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
90 90  
91 91  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
92 92  
... ... @@ -94,28 +94,30 @@
94 94  
95 95  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
96 96  
97 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
98 98  
99 -(% 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
100 100  
101 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
102 102  
103 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
104 104  
105 105  (% style="color:#000000" %)Ответ:
106 106  
107 -(% style="color:#000000" %){
108 - "agentId": "", ~/~/ идентификатор клиента
109 - "parentId": "", ~/~/ идентификатор клиента-родителя
110 - "name": "", ~/~/ наименование клиента
111 - "fullName": "", ~/~/ полное наименование клиента
112 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
113 - "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 - Отказ)
114 114  }
115 115  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
116 116  
117 -== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
118 -
119 119  (% class="box successmessage" %)
120 120  (((
121 121  **POST /api/v3/agents **
... ... @@ -135,6 +135,7 @@
135 135   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 136   "name": "string", ~/~/ имя
137 137   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
138 138   "isForeign": true, ~/~/ иностранный контрагент
139 139   "district": "string", ~/~/ округ
140 140   "region": "string", ~/~/ регион
... ... @@ -159,6 +159,7 @@
159 159   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 160   "name": "string", ~/~/ имя
161 161   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
162 162   "isForeign": true, ~/~/ иностранный контрагент
163 163   "district": "string", ~/~/ округ
164 164   "region": "string", ~/~/ регион
... ... @@ -175,9 +175,8 @@
175 175   "bankKS": "string" ~/~/ корр. счёт
176 176  }
177 177  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
178 178  
179 -== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
180 -
181 181  (% class="box warningmessage" %)
182 182  (((
183 183  **PUT /api/v3/agents**
... ... @@ -199,6 +199,7 @@
199 199   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
200 200   "name": "string", ~/~/ имя
201 201   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
202 202   "isForeign": true, ~/~/ иностранный контрагент
203 203   "district": "string", ~/~/ округ
204 204   "region": "string", ~/~/ регион
... ... @@ -239,9 +239,8 @@
239 239   "bankKS": "string" ~/~/ корр. счёт
240 240  }
241 241  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
242 242  
243 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
244 -
245 245  (% class="box errormessage" %)
246 246  (((
247 247  **DELETE /api/v3/agents/{clientId}**
... ... @@ -259,12 +259,10 @@
259 259  
260 260  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
261 261  
262 -
263 263  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
264 264  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
265 265  
266 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
267 -
268 268  (% class="box successmessage" %)
269 269  (((
270 270  (% lang="en-US" %)**POST /api/v3/users**
... ... @@ -280,7 +280,8 @@
280 280  
281 281  (% style="color:#000000" %)Параметры в теле запроса (JSON):
282 282  
283 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
284 284   "lastName": "", ~/~/ фамилия
285 285   "firstName": "", ~/~/ имя
286 286   "position": "", ~/~/ должность
... ... @@ -289,17 +289,41 @@
289 289   "login": "", ~/~/ логин (обязателен)
290 290   "password": "", ~/~/ пароль (обязателен)
291 291   "email": "", ~/~/ email (обязателен)
292 - "description": "", ~/~/ описание
293 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
294 294   "parentId": "", ~/~/ Guid родительского агента
295 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
296 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
297 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
298 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
299 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
300 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 + "doubleAuth":
340 + {
341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 + },
344 + "groups":
345 + [
346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 + ],
348 + "customGroups":
349 + [
350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 + ],
352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
301 301  }
302 302  
355 +{
356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 + "lastName": "string",
358 + "firstName": "string",
359 + "position": "string",
360 + "phone": "string",
361 + "organization": "string",
362 + "login": "string",
363 + "password": "string",
364 + "email": "string",
365 +
366 +
303 303  (% style="text-align:left" %)
304 304  (% style="color:#000000; font-weight:normal" %)Ответ:
305 305  
... ... @@ -328,10 +328,9 @@
328 328  (% style="text-align:left" %)
329 329  (% style="color:#000000; font-weight:normal" %)}
330 330  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
331 331  
332 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
333 -
334 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
335 335  (((
336 336  (% lang="en-US" %)**POST /api/v3/users/find**
337 337  )))
... ... @@ -377,10 +377,9 @@
377 377  
378 378  (% style="color:#000000" %)}
379 379  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
380 380  
381 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
382 -
383 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
384 384  (((
385 385  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
386 386  )))
... ... @@ -412,8 +412,11 @@
412 412   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
413 413   "description": "", ~/~/ Описание
414 414   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
415 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
416 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
417 417   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
418 418   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
419 419   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -427,9 +427,8 @@
427 427  )))
428 428  )))
429 429  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
430 430  
431 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
432 -
433 433  (% class="box warningmessage" %)
434 434  (((
435 435  (% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -457,7 +457,9 @@
457 457   "phone": "" , ~/~/ телефон
458 458   "organization": "" , ~/~/ организация
459 459   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
460 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
461 461   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
462 462  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
463 463   "isEnabled": "" , ~/~/ признак включения
... ... @@ -464,9 +464,12 @@
464 464   "parentId": "" , ~/~/ Guid родительского агента
465 465   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
466 466   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
467 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
468 - "kind": "" , ~/~/ тип аутентификации
469 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
470 470   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
471 471  
472 472  (% lang="en-US" style="text-align:left" %)
... ... @@ -492,8 +492,12 @@
492 492   "isEnabled": "" , ~/~/ признак включения
493 493   "parentId": "" , ~/~/ Guid родительского агента
494 494   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
495 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
496 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
497 497   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
498 498   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
499 499  
... ... @@ -500,9 +500,8 @@
500 500  (% lang="en-US" style="text-align:left" %)
501 501  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
502 502  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
503 503  
504 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
505 -
506 506  (% class="box warningmessage" %)
507 507  (((
508 508  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
... ... @@ -531,9 +531,8 @@
531 531  (% style="text-align:left" %)
532 532  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
533 533  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
534 534  
535 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
536 -
537 537  (% class="box warningmessage" %)
538 538  (((
539 539  **POST /api/v3/users/disable**
... ... @@ -554,9 +554,8 @@
554 554  
555 555  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
556 556  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
557 557  
558 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
559 -
560 560  (% class="box warningmessage" %)
561 561  (((
562 562  **POST /api/v3/users/enable**
... ... @@ -590,11 +590,10 @@
590 590  }
591 591  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
592 592  "users" - массив id пользователей, которых не удалось включить или отключить.
593 -
594 -
595 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
596 596  )))
597 597  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
598 598  (% class="box errormessage" %)
599 599  (((
600 600  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -613,12 +613,10 @@
613 613  (% style="text-align:left" %)
614 614  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
615 615  
616 -
617 617  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
618 618  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
619 619  
620 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
621 -
622 622  (% class="box infomessage" %)
623 623  (((
624 624  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -661,6 +661,8 @@
661 661   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
662 662   "mileage": "", ~/~/ Пробег по нормам в метрах
663 663   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
664 664   },
665 665   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
666 666   {
... ... @@ -687,9 +687,8 @@
687 687  (% style="text-align:left" %)
688 688  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
689 689  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
690 690  
691 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
692 -
693 693  (% class="box successmessage" %)
694 694  (((
695 695  (% lang="en-US" %)**POST /api/v3/vehicles**
... ... @@ -808,10 +808,9 @@
808 808  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
809 809  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
810 810  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
811 811  
812 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
813 -
814 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
815 815  (((
816 816  (% lang="en-US" %)**POST /api/v3/vehicles/find**
817 817  )))
... ... @@ -891,9 +891,8 @@
891 891  
892 892  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
893 893  
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
894 894  
895 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
896 -
897 897  (% class="box successmessage" %)
898 898  (((
899 899  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -938,9 +938,8 @@
938 938  (% style="text-align:left" %)
939 939  (% style="color:#000000" %) }
940 940  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
941 941  
942 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
943 -
944 944  (% class="box warningmessage" %)
945 945  (((
946 946  (% lang="en-US" %)**PUT /api/v3/vehicles**
... ... @@ -1068,9 +1068,8 @@
1068 1068  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1069 1069  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1070 1070  
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1071 1071  
1072 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1073 -
1074 1074  (% class="box errormessage" %)
1075 1075  (((
1076 1076  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -1089,12 +1089,10 @@
1089 1089  (% style="text-align:left" %)
1090 1090  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1091 1091  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1092 1092  
1093 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1094 1094  
1095 -
1096 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1097 -
1098 1098  (% class="box infomessage" %)
1099 1099  (((
1100 1100  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
... ... @@ -1118,12 +1118,10 @@
1118 1118  (% style="text-align:left" %)
1119 1119  (% style="color:#000000" %)}
1120 1120  
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1121 1121  
1122 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1123 1123  
1124 -
1125 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1126 -
1127 1127  (% class="box infomessage" %)
1128 1128  (((
1129 1129  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
... ... @@ -1135,7 +1135,7 @@
1135 1135  
1136 1136  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1137 1137  
1138 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1139 1139  
1140 1140  (% style="color:#000000" %)Ответ:
1141 1141  
... ... @@ -1148,7 +1148,99 @@
1148 1148  (% style="text-align:left" %)
1149 1149  (% style="color:#000000" %)}
1150 1150  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1151 1151  
1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1214 +
1215 +(% class="box infomessage" style="text-align: left;" %)
1216 +(((
1217 +**POST /api/v3/terminalMessages/count**
1218 +)))
1219 +
1220 +(% style="text-align: left;" %)
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1222 +
1223 +(% style="text-align: left;" %)
1224 +Метод запроса **POST**
1225 +
1226 +(% style="text-align: left;" %)
1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1228 +
1229 +(% style="text-align: left;" %)
1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1231 +
1232 +(% style="text-align: left;" %)
1233 +{
1234 + "vehicleIds": [
1235 + id ~/~/ здесь передается список идентификаторов объектов
1236 + ],
1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1239 +}
1240 +
1241 +(% style="text-align: left;" %)
1242 +Ответ:
1243 +
1244 +(% style="text-align: left;" %)
1245 +[
1246 + {
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1248 + "count": 0 ~/~/ количество сообщений за период
1249 + }
1250 +]
1251 +
1252 +
1253 +(% style="text-align: left;" %)
1254 +(% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**
1255 +
1256 +(% class="box infomessage" %)
1257 +(((
1258 +**POST /api/v3/terminalMessages**
1259 +)))
1260 +
1261 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1262 +
1263 +(% style="text-align: left;" %)
1264 +Метод запроса **POST**
1265 +
1266 +(% style="text-align: left;" %)
1267 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1268 +
1269 +(% style="text-align: left;" %)
1270 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1271 +
1272 +{
1273 + "vehicleId": 0, ~/~/ id объекта
1274 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1275 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1276 +}
1277 +
1278 +Ответ:
1279 +
1280 +[
1281 + {
1282 + "messages": [
1283 + {
1284 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1285 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1286 + "speed": 0, ~/~/ Скорость, км/ч
1287 + "altitude": 0, ~/~/ Высота, м
1288 + "latitude": 0, ~/~/ Широта [-90°;90°]
1289 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1290 + "satellites": 0, ~/~/ Кол-во спутников
1291 + "voltage": 0, ~/~/ Напряжение
1292 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1293 + "additionalProp1": "string",
1294 + "additionalProp2": "string",
1295 + "additionalProp3": "string"
1296 + },
1297 + "photoCount": 0 ~/~/ Кол-во фото
1298 + }
1299 + ]
1300 + }
1301 +]
1302 +
1303 +
1152 1152  (% class="box" lang="en-US" style="text-align: center;" %)
1153 1153  (((
1154 1154  (% 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 г.