Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,25 +1,28 @@ 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 -(% class="box successmessage" %) 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 +(% class="box infomessage" %) 21 21 ((( 22 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**25 +(% lang="en-US" %)**POST /api/v3/auth/login** 23 23 ))) 24 24 25 25 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. ... ... @@ -35,9 +35,9 @@ 35 35 (% style="color:#000000" %){ 36 36 "login": "testuser", 37 37 "password": "testuser" 38 -}(%%) 39 - 41 +} 40 40 43 + 41 41 (% style="color:#000000" %)**Ответ:** 42 42 43 43 (% lang="en-US" %) ... ... @@ -52,13 +52,14 @@ 52 52 53 53 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 54 54 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 55 55 56 56 (% class="box infomessage" %) 57 57 ((( 58 -(% 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** 59 59 ))) 60 60 61 -(% style="color:#000000" %) 65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 62 62 63 63 (% style="color:#000000" %)Метод запроса: **GET** 64 64 ... ... @@ -69,18 +69,58 @@ 69 69 (% lang="en-US" %) 70 70 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 71 71 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 72 72 73 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 74 74 ((( 75 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 76 76 ))) 77 77 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 + 78 78 (% class="box infomessage" %) 79 79 ((( 80 -(% 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(%%)** 81 81 ))) 82 82 83 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 84 84 85 85 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 86 86 ... ... @@ -88,29 +88,33 @@ 88 88 89 89 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 90 90 91 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 92 92 93 -(% 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 94 94 95 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 96 96 97 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 98 98 99 99 (% style="color:#000000" %)Ответ: 100 100 101 -(% style="color:#000000" %){ 102 - "agentId": "", ~/~/ идентификатор клиента 103 - "parentId": "", ~/~/ идентификатор клиента-родителя 104 - "name": "", ~/~/ наименование клиента 105 - "fullName": "", ~/~/ полное наименование клиента 106 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 107 - "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 - Отказ) 108 108 } 109 109 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 110 110 111 111 (% class="box successmessage" %) 112 112 ((( 113 -** Добавление клиента —POST /api/v3/agents **161 +**POST /api/v3/agents ** 114 114 ))) 115 115 116 116 Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). ... ... @@ -127,6 +127,7 @@ 127 127 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 128 128 "name": "string", ~/~/ имя 129 129 "fullName": "string", ~/~/ полное наименование 178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 130 130 "isForeign": true, ~/~/ иностранный контрагент 131 131 "district": "string", ~/~/ округ 132 132 "region": "string", ~/~/ регион ... ... @@ -151,6 +151,7 @@ 151 151 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 152 152 "name": "string", ~/~/ имя 153 153 "fullName": "string", ~/~/ полное наименование 203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 154 154 "isForeign": true, ~/~/ иностранный контрагент 155 155 "district": "string", ~/~/ округ 156 156 "region": "string", ~/~/ регион ... ... @@ -167,10 +167,11 @@ 167 167 "bankKS": "string" ~/~/ корр. счёт 168 168 } 169 169 220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 170 170 171 171 (% class="box warningmessage" %) 172 172 ((( 173 -** Редактирование клиента —PUT /api/v3/agents**224 +**PUT /api/v3/agents** 174 174 ))) 175 175 176 176 Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). ... ... @@ -189,6 +189,7 @@ 189 189 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 190 190 "name": "string", ~/~/ имя 191 191 "fullName": "string", ~/~/ полное наименование 243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 192 192 "isForeign": true, ~/~/ иностранный контрагент 193 193 "district": "string", ~/~/ округ 194 194 "region": "string", ~/~/ регион ... ... @@ -229,13 +229,13 @@ 229 229 "bankKS": "string" ~/~/ корр. счёт 230 230 } 231 231 284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 232 232 233 233 (% class="box errormessage" %) 234 234 ((( 235 -** Удаление клиента —DELETE /api/v3/agents/{clientId}**288 +**DELETE /api/v3/agents/{clientId}** 236 236 ))) 237 237 238 - 239 239 Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 240 240 241 241 Метод запроса: **DELETE** ... ... @@ -248,19 +248,16 @@ 248 248 249 249 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 250 250 303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 251 251 305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 252 252 253 -(% class="box" style="text-align: center;" %) 254 -((( 255 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 256 -))) 257 - 258 258 (% class="box successmessage" %) 259 259 ((( 260 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 261 261 ))) 262 262 263 -(% style="color:#000000" %) 312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 264 264 265 265 (% style="color:#000000" %)Метод запроса: **POST** 266 266 ... ... @@ -270,7 +270,8 @@ 270 270 271 271 (% style="color:#000000" %)Параметры в теле запроса (JSON): 272 272 273 -(% style="color:#000000" %){ 322 +(% style="color:#000000" %) 323 +{ 274 274 "lastName": "", ~/~/ фамилия 275 275 "firstName": "", ~/~/ имя 276 276 "position": "", ~/~/ должность ... ... @@ -279,17 +279,41 @@ 279 279 "login": "", ~/~/ логин (обязателен) 280 280 "password": "", ~/~/ пароль (обязателен) 281 281 "email": "", ~/~/ email (обязателен) 282 - "description": "", ~/~/ описание 283 - "isEnabled": "", ~/~/ признак включения 332 + "description": "string", ~/~/ Описание 333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 284 284 "parentId": "", ~/~/ Guid родительского агента 285 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 286 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 287 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 288 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 289 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 290 - "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 - Азербайджанский 291 291 } 292 292 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 + 293 293 (% style="text-align:left" %) 294 294 (% style="color:#000000; font-weight:normal" %)Ответ: 295 295 ... ... @@ -318,13 +318,14 @@ 318 318 (% style="text-align:left" %) 319 319 (% style="color:#000000; font-weight:normal" %)} 320 320 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 321 321 322 -(% class="box successmessage" %)397 +(% class="box infomessage" %) 323 323 ((( 324 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**399 +(% lang="en-US" %)**POST /api/v3/users/find** 325 325 ))) 326 326 327 -(% style="color:#000000" %) 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 328 328 329 329 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 330 330 ... ... @@ -365,13 +365,14 @@ 365 365 366 366 (% style="color:#000000" %)} 367 367 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 368 368 369 -(% class="box successmessage" %)445 +(% class="box infomessage" %) 370 370 ((( 371 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 372 372 ))) 373 373 374 -(% style="color:#000000" %) 450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 375 375 376 376 (% style="color:#000000" %)Метод запроса: **GET** 377 377 ... ... @@ -398,8 +398,11 @@ 398 398 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 399 399 "description": "", ~/~/ Описание 400 400 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 401 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 402 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 477 + "doubleAuth": 478 + { 479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 + }, 403 403 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 404 404 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 405 405 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован ... ... @@ -413,13 +413,14 @@ 413 413 ))) 414 414 ))) 415 415 495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 416 416 417 417 (% class="box warningmessage" %) 418 418 ((( 419 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 420 420 ))) 421 421 422 -(% style="color:#000000" %) 502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 423 423 424 424 (% style="color:#000000" %)Метод запроса: **PUT** 425 425 ... ... @@ -427,8 +427,6 @@ 427 427 428 428 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 429 429 430 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 431 - 432 432 (% lang="en-US" style="text-align:left" %) 433 433 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 434 434 ... ... @@ -443,7 +443,9 @@ 443 443 "phone": "" , ~/~/ телефон 444 444 "organization": "" , ~/~/ организация 445 445 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 446 -(% 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 - отключено 447 447 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 448 448 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 449 449 "isEnabled": "" , ~/~/ признак включения ... ... @@ -450,9 +450,12 @@ 450 450 "parentId": "" , ~/~/ Guid родительского агента 451 451 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 452 452 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 453 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 454 - "kind": "" , ~/~/ тип аутентификации 455 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 456 456 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 457 457 458 458 (% lang="en-US" style="text-align:left" %) ... ... @@ -478,8 +478,12 @@ 478 478 "isEnabled": "" , ~/~/ признак включения 479 479 "parentId": "" , ~/~/ Guid родительского агента 480 480 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 481 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 482 - "kind": "" , ~/~/ тип аутентификации 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 483 483 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 484 484 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 485 485 ... ... @@ -486,13 +486,14 @@ 486 486 (% lang="en-US" style="text-align:left" %) 487 487 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 488 488 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 489 489 490 490 (% class="box warningmessage" %) 491 491 ((( 492 -(% style="color:#000000" %) **Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 493 493 ))) 494 494 495 -(% style="color:#000000" %) 583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 496 496 497 497 (% style="color:#000000" %)Метод запроса: **PUT** 498 498 ... ... @@ -515,10 +515,11 @@ 515 515 (% style="text-align:left" %) 516 516 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 517 517 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 518 518 519 519 (% class="box warningmessage" %) 520 520 ((( 521 -** Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/disable**610 +**POST /api/v3/users/disable** 522 522 ))) 523 523 524 524 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). ... ... @@ -536,10 +536,11 @@ 536 536 537 537 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 538 538 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 539 539 540 540 (% class="box warningmessage" %) 541 541 ((( 542 -** Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/enable**632 +**POST /api/v3/users/enable** 543 543 ))) 544 544 545 545 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). ... ... @@ -570,15 +570,16 @@ 570 570 } 571 571 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 572 572 "users" - массив id пользователей, которых не удалось включить или отключить. 573 - 574 574 ))) 575 575 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 576 576 (% class="box errormessage" %) 577 577 ((( 578 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 579 579 ))) 580 580 581 -(% style="color:#000000" %) 672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 582 582 583 583 (% style="color:#000000" %)Метод запроса: **DELETE** 584 584 ... ... @@ -591,20 +591,18 @@ 591 591 (% style="text-align:left" %) 592 592 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 593 593 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 594 594 595 -(% class="box" style="text-align: center;" %) 596 -((( 597 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 598 -))) 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 599 599 600 600 (% class="box infomessage" %) 601 601 ((( 602 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 603 603 ))) 604 604 605 -(% style="color:#000000" %) 694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 606 606 607 -(% style="color:#000000" %) 696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 608 608 609 609 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 610 610 ... ... @@ -639,6 +639,8 @@ 639 639 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 640 640 "mileage": "", ~/~/ Пробег по нормам в метрах 641 641 "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 642 642 }, 643 643 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 644 644 { ... ... @@ -665,13 +665,14 @@ 665 665 (% style="text-align:left" %) 666 666 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 667 667 759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 668 668 669 669 (% class="box successmessage" %) 670 670 ((( 671 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**763 +(% lang="en-US" %)**POST /api/v3/vehicles** 672 672 ))) 673 673 674 -(% style="color:#000000" %) 766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 675 675 676 676 (% style="color:#000000" %)Метод запроса: **POST** 677 677 ... ... @@ -784,15 +784,16 @@ 784 784 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 785 785 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 786 786 879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 787 787 788 -(% class="box successmessage" %)881 +(% class="box infomessage" %) 789 789 ((( 790 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**883 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 791 791 ))) 792 792 793 -(% style="color:#000000" %) 886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 794 794 795 -(% style="color:#000000" %) 888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 796 796 797 797 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 798 798 ... ... @@ -829,7 +829,7 @@ 829 829 "customFields": null ~/~/ значение любого из произвольных полей ТС 830 830 } 831 831 832 -(% style="color:#000000" %) 925 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 833 833 834 834 (% style="color:#000000" %)Ответ: 835 835 ... ... @@ -865,13 +865,14 @@ 865 865 866 866 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 867 867 961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 868 868 869 869 (% class="box successmessage" %) 870 870 ((( 871 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**965 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 872 872 ))) 873 873 874 -(% style="color:#000000" %) 968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 875 875 876 876 (% style="color:#000000" %)Метод запроса: **POST** 877 877 ... ... @@ -910,13 +910,14 @@ 910 910 (% style="text-align:left" %) 911 911 (% style="color:#000000" %) } 912 912 1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 913 913 914 914 (% class="box warningmessage" %) 915 915 ((( 916 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1011 +(% lang="en-US" %)**PUT /api/v3/vehicles** 917 917 ))) 918 918 919 -(% style="color:#000000" %) 1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 920 920 921 921 (% style="color:#000000" %)Метод запроса: **PUT** 922 922 ... ... @@ -1038,13 +1038,14 @@ 1038 1038 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1039 1039 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1040 1040 1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1041 1041 1042 1042 (% class="box errormessage" %) 1043 1043 ((( 1044 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1140 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1045 1045 ))) 1046 1046 1047 -(% style="color:#000000" %) 1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1048 1048 1049 1049 (% style="color:#000000" %)Метод запроса: **DELETE** 1050 1050 ... ... @@ -1057,18 +1057,16 @@ 1057 1057 (% style="text-align:left" %) 1058 1058 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1059 1059 1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1060 1060 1061 -(% class="box" lang="en-US" style="text-align: center;" %) 1062 -((( 1063 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1064 -))) 1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1065 1065 1066 1066 (% class="box infomessage" %) 1067 1067 ((( 1068 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1162 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1069 1069 ))) 1070 1070 1071 -(% style="color:#000000" %) 1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1072 1072 1073 1073 (% style="color:#000000" %)Метод запроса: **GET** 1074 1074 ... ... @@ -1086,24 +1086,22 @@ 1086 1086 (% style="text-align:left" %) 1087 1087 (% style="color:#000000" %)} 1088 1088 1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1089 1089 1090 -(% class="box" style="text-align: center;" %) 1091 -((( 1092 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 1093 -))) 1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1094 1094 1095 1095 (% class="box infomessage" %) 1096 1096 ((( 1097 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов датчиков**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**1189 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1098 1098 ))) 1099 1099 1100 -(% style="color:#000000" %) 1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1101 1101 1102 1102 (% style="color:#000000" %)Метод запроса: **GET** 1103 1103 1104 1104 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1105 1105 1106 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1107 1107 1108 1108 (% style="color:#000000" %)Ответ: 1109 1109 ... ... @@ -1116,7 +1116,97 @@ 1116 1116 (% style="text-align:left" %) 1117 1117 (% style="color:#000000" %)} 1118 1118 1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1119 1119 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 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 + 1254 +(% class="box infomessage" %) 1255 +((( 1256 +**POST /api/v3/terminalMessages** 1257 +))) 1258 + 1259 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1260 + 1261 +(% style="text-align: left;" %) 1262 +Метод запроса **POST** 1263 + 1264 +(% style="text-align: left;" %) 1265 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1266 + 1267 +(% style="text-align: left;" %) 1268 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1269 + 1270 +{ 1271 + "vehicleId": 0, ~/~/ id объекта 1272 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1273 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1274 +} 1275 + 1276 +Ответ: 1277 + 1278 +[ 1279 + { 1280 + "messages": [ 1281 + { 1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 + "speed": 0, ~/~/ Скорость, км/ч 1285 + "altitude": 0, ~/~/ Высота, м 1286 + "latitude": 0, ~/~/ Широта [-90°;90°] 1287 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 + "satellites": 0, ~/~/ Кол-во спутников 1289 + "voltage": 0, ~/~/ Напряжение 1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1291 + "additionalProp1": "string", 1292 + "additionalProp2": "string", 1293 + "additionalProp3": "string" 1294 + }, 1295 + "photoCount": 0 ~/~/ Кол-во фото 1296 + } 1297 + ] 1298 + } 1299 +] 1300 + 1301 + 1120 1120 (% class="box" lang="en-US" style="text-align: center;" %) 1121 1121 ((( 1122 1122 (% 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]] **