Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -34,18 +34,8 @@ 34 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ:** 37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 38 38 39 -(% lang="en-US" %) 40 -(% style="color:#000000" %){ 41 - 42 -(% lang="en-US" %) 43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 - "User": "" , ~/~/ имя пользователя 45 - 46 -(% lang="en-US" %) 47 - } 48 - 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 51 51 ... ... @@ -92,18 +92,16 @@ 92 92 93 93 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 94 94 95 -(% style="color:#000000" %)Ответ: 85 +(% style="color:#000000" %)Ответ: [ { 86 + "agentId": "", ~/~/ идентификатор клиента 87 + "parentId": "", ~/~/ идентификатор клиента-родителя 88 + "name": "", ~/~/ наименование клиента 89 + "fullName": "", ~/~/ полное наименование клиента 90 + "agentInfoType": "", ~/~/ тип клиента1 91 + "status": "", ~/~/ статус клиента 92 + }, … ] 96 96 97 -(% style="color:#000000" %){ 98 - "agentId": "", ~/~/ идентификатор клиента 99 - "parentId": "", ~/~/ идентификатор клиента-родителя 100 - "name": "", ~/~/ наименование клиента 101 - "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента1 103 - "status": "", ~/~/ статус клиента 104 - } 105 105 106 - 107 107 (% 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" %)] 108 108 109 109 ... ... @@ -125,57 +125,12 @@ 125 125 126 126 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 127 127 128 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 116 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } 129 129 130 -(% style="color:#000000" %){ 131 - "lastName": "", ~/~/ фамилия 132 - "firstName": "", ~/~/ имя 133 - "position": "", ~/~/ должность 134 - "phone": "", ~/~/ телефон 135 - "organization": "", ~/~/ организация 136 - "login": "", ~/~/ логин 137 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 138 - "email": "", ~/~/ email 139 - "description": "", ~/~/ описание 140 - "isEnabled": "", ~/~/ признак включения 141 - "parentId": "", ~/~/ Guid родительского агента 142 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 143 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 144 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 145 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 - "groups": "" , ~/~/ группы пользователя, названия групп 148 - } 149 - 150 150 (% style="text-align:left" %) 151 -(% style="color:#000000; font-weight:normal" %)Ответ: 119 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 152 152 153 -(% style="text-align:left" %) 154 -(% style="color:#000000; font-weight:normal" %){ 155 155 156 -(% style="text-align:left" %) 157 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 158 - "lastName": "" , ~/~/ Фамилия , 159 - "firstName": "" , ~/~/ Имя 160 - "position": "" , ~/~/ Должность 161 - "phone": "" , ~/~/ Телефон 162 - "organization": "" , ~/~/ Организация 163 - "login": "" , ~/~/ Логин 164 - "password": "" , ~/~/ Пароль 165 - "email": "" , ~/~/ Email 166 - "description": "" , ~/~/ Описание 167 - "isEnabled": "" , ~/~/ Признак включения 168 - "parentId": "" , ~/~/ Guid родительского агента 169 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 170 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 171 - "kind": "" , ~/~/ тип аутентификации 172 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 173 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 174 - 175 -(% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %) } 177 - 178 - 179 179 (% class="box successmessage" %) 180 180 ((( 181 181 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** ... ... @@ -189,38 +189,25 @@ 189 189 190 190 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 191 191 192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 135 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 193 193 194 -(% style="color:#000000" %){ 137 +(% class="western" %) 138 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 139 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 140 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 141 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 195 195 196 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 197 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 198 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 143 +(% style="color:#000000" %)} 200 200 201 -(% style="color:#000000" %) }145 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 202 202 203 -(% style="color:#000000" %)Ответ: 147 +(% class="western" style="margin-bottom:19px" %) 148 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 204 204 205 -(% style="color:#000000" %){ (%%) 150 +(% lang="en-US" style="text-align:left" %) 151 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 206 206 207 - "id": "" , ~/~/ идентификатор пользователя 208 - "lastName": "" , ~/~/ фамилия 209 - "firstName": "" , ~/~/ имя 210 - "position": "" , ~/~/ должность 211 - "phone": "" , ~/~/ телефон 212 - "parentId": "" , ~/~/ идентификатор клиента-родителя 213 - "parentName": "" , ~/~/ наименование клиента-родителя 214 - "organization": "" , ~/~/ организация 215 - "login": "" , ~/~/ логин 216 - "email": "" , ~/~/ E-mail 217 - "sessionDuration":"", ~/~/ длительность сессии в минутах 218 - "status": "1", ~/~/ статус пользователя 219 - "astLogged": "", ~/~/ дата/время последней авторизации 220 220 221 -(% style="color:#000000" %) } 222 - 223 - 224 224 (% class="box warningmessage" %) 225 225 ((( 226 226 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -235,63 +235,9 @@ 235 235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 236 236 237 237 (% lang="en-US" style="text-align:left" %) 238 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 168 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } // 239 239 240 -(% lang="en-US" style="text-align:left" %) 241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 242 242 243 -(% lang="en-US" style="text-align:left" %) 244 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 245 - "lastName": "" , ~/~/ фамилия 246 - "firstName": "" , ~/~/ имя 247 - "position": "" , ~/~/ должность 248 - "phone": "" , ~/~/ телефон 249 - "organization": "" , ~/~/ организация 250 - "login": "" , ~/~/ логин 251 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 252 - "email": "" , ~/~/ email 253 - "description": "" , ~/~/ описание 254 - "isEnabled": "" , ~/~/ признак включения 255 - "parentId": "" , ~/~/ Guid родительского агента 256 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 257 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 258 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 259 - "kind": "" , ~/~/ тип аутентификации 260 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 261 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 262 - 263 -(% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 265 - 266 -(% lang="en-US" style="text-align:left" %) 267 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 268 - 269 -(% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 271 - 272 -(% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 274 - "lastName": "" , ~/~/ фамилия 275 - "firstName": "" , ~/~/ имя 276 - "position": "" , ~/~/ должность 277 - "phone": "" , ~/~/ телефон 278 - "organization": "" , ~/~/ организация 279 - "login": "" , ~/~/ логин 280 - "password": "" , ~/~/ пароль 281 - "email": "" , ~/~/ email 282 - "description": "" , ~/~/ описание 283 - "isEnabled": "" , ~/~/ признак включения 284 - "parentId": "" , ~/~/ Guid родительского агента 285 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 286 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 - "kind": "" , ~/~/ тип аутентификации 288 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 290 - 291 -(% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 293 - 294 - 295 295 (% class="box warningmessage" %) 296 296 ((( 297 297 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** ... ... @@ -301,22 +301,16 @@ 301 301 302 302 (% style="color:#000000" %)Метод запроса: **PUT** 303 303 304 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 180 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса: 305 305 306 -(% style="color:#000000" %)Параметр запроса: { id}- Guidпользователя182 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 307 307 308 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 184 +(% class="western" %) 185 +{{{ "description": "", // описание 186 + "data": "" // данные, связанные со сменой статуса}}} 309 309 310 -(% style="color:#000000" %) Параметры в теле запроса (JSON):188 +(% style="color:#000000" %)} 311 311 312 -(% style="color:#000000" %){ 313 - 314 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 315 - "description": "" , ~/~/ описание 316 - "data": "" , ~/~/ данные, связанные со сменой статуса 317 - 318 - (% style="color:#000000" %)} 319 - 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 322 322 ... ... @@ -332,10 +332,8 @@ 332 332 333 333 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 334 334 335 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 205 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 336 336 337 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 338 - 339 339 (% style="text-align:left" %) 340 340 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 341 341 ... ... @@ -370,20 +370,24 @@ 370 370 371 371 (% style="color:#000000" %){ 372 372 373 - "vehicleId": "" , ~/~/ идентификатор объекта 374 - "name": "" , ~/~/ имя объекта 375 - "imei": "" , ~/~/ IMEI объекта 376 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 377 - "deviceTypeName": "" , ~/~/ наименование устройства объекта 378 - "parentId": "" , ~/~/ идентификатор клиента-родителя 379 - "parentName": "" , ~/~/ наименование клиента-родителя, 380 - "modelId": "" , ~/~/ идентификатор модели объекта 381 - "modelName": "" , ~/~/ наименование модели объекта, 382 - "unitId": "" , ~/~/ идентификатор подразделения 383 - "unitName": "" , ~/~/ наименование подразделения 384 - "status": "" , ~/~/ статус объекта 241 +(% class="western" %) 242 +{{{ "vehicleId": “”, // идентификатор объекта 243 + "name": "", // имя объекта 244 + "imei": "", // IMEI объекта 245 + "deviceTypeId": “”, // идентификатор устройства объекта 246 + "deviceTypeName": "" // наименование устройства объекта 247 + "parentId": "", // идентификатор клиента-родителя 248 + "parentName": "" // наименование клиента-родителя, 249 + "modelId": "", // идентификатор модели объекта 250 + "modelName": "" // наименование модели объекта, 251 + "unitId": "", // идентификатор подразделения 252 + "unitName": "", // наименование подразделения 253 + "status": “”, // статус объекта 254 + ... 255 + }, 256 + ...}}} 385 385 386 - 258 +(% style="color:#000000" %)} 387 387 388 388 (% style="text-align:left" %) 389 389 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: