Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 16.1 >
edited by Артем Шемяков
on 2022/09/01 15:36
To version < 17.1 >
edited by Артем Шемяков
on 2022/09/01 16:30
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API ==
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 4  == ==
5 5  
... ... @@ -17,37 +17,6 @@
17 17  
18 18  (% class="box" style="text-align: center;" %)
19 19  (((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
21 -)))
22 -
23 -(% class="box infomessage" %)
24 -(((
25 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
26 -)))
27 -
28 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
29 -
30 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
31 -
32 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
33 -
34 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
35 -
36 -(% style="color:#000000" %)Метод запроса: **GET**
37 -
38 -(% 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>
39 -
40 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
41 -
42 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
43 -
44 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
45 -
46 -(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
47 -
48 -
49 -(% class="box" style="text-align: center;" %)
50 -(((
51 51  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
52 52  )))
53 53  
... ... @@ -87,69 +87,37 @@
87 87  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
88 88  
89 89  
90 -(% class="box" lang="en-US" style="text-align: center;" %)
59 +(% class="box" style="text-align: center;" %)
91 91  (((
92 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
61 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
93 93  )))
94 94  
95 95  (% class="box infomessage" %)
96 96  (((
97 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
66 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
98 98  )))
99 99  
100 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
69 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
101 101  
102 -(% style="color:#000000" %)Метод запроса: **GET**
71 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
103 103  
104 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
73 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
105 105  
106 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
107 107  
108 -(% style="color:#000000" %)Ответ: [
109 -
110 -(% class="western" %)
111 -{{{ {
112 - "deviceTypeId" : "", // ID типа устройства
113 - "deviceTypeName" : "" // Название типа устройства
114 - },}}}
115 -
116 -(% style="text-align:left" %)
117 -(% style="color:#000000" %)…** **]
118 -
119 -
120 -(% class="box" style="text-align: center;" %)
121 -(((
122 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
123 -)))
124 -
125 -(% class="box infomessage" %)
126 -(((
127 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
128 -)))
129 -
130 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
131 -
132 132  (% style="color:#000000" %)Метод запроса: **GET**
133 133  
134 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
79 +(% 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>
135 135  
136 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
137 137  
138 -(% style="color:#000000" %)Ответ: [
83 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
139 139  
140 -(% class="western" style="margin-bottom:19px" %)
141 -{{{ {}}}
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
142 142  
143 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
87 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
144 144  
145 -(% class="western" %)
146 -{{{ "description": "" // Описание
147 - },}}}
148 148  
149 -(% style="text-align:left" %)
150 -(% style="color:#000000" %)… ]
151 -
152 -
153 153  (% class="box" style="text-align: center;" %)
154 154  (((
155 155  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -586,5 +586,68 @@
586 586  
587 587  (% class="box" lang="en-US" style="text-align: center;" %)
588 588  (((
526 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
527 +)))
528 +
529 +(% class="box infomessage" %)
530 +(((
531 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
532 +)))
533 +
534 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
535 +
536 +(% style="color:#000000" %)Метод запроса: **GET**
537 +
538 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
539 +
540 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
541 +
542 +(% style="color:#000000" %)Ответ: [
543 +
544 +(% class="western" %)
545 +{{{ {
546 + "deviceTypeId" : "", // ID типа устройства
547 + "deviceTypeName" : "" // Название типа устройства
548 + },}}}
549 +
550 +(% style="text-align:left" %)
551 +(% style="color:#000000" %)…** **]
552 +
553 +
554 +(% class="box" style="text-align: center;" %)
555 +(((
556 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
557 +)))
558 +
559 +(% class="box infomessage" %)
560 +(((
561 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
562 +)))
563 +
564 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
565 +
566 +(% style="color:#000000" %)Метод запроса: **GET**
567 +
568 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
569 +
570 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
571 +
572 +(% style="color:#000000" %)Ответ: [
573 +
574 +(% class="western" style="margin-bottom:19px" %)
575 +{{{ {}}}
576 +
577 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
578 +
579 +(% class="western" %)
580 +{{{ "description": "" // Описание
581 + },}}}
582 +
583 +(% style="text-align:left" %)
584 +(% style="color:#000000" %)… ]
585 +
586 +
587 +(% class="box" lang="en-US" style="text-align: center;" %)
588 +(((
589 589  (% 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]] **
590 590  )))

Меню

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