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
-
... ... @@ -12,14 +12,18 @@ 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" %)**РазделАвторизация**(%%)====16 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 19 20 -(% class="box successmessage" %) 19 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Авторизация**(%%) ==== 20 + 21 + 22 +===== (% style="color:#000000; line-height:100%" %)**Авторизация**(%%) ===== 23 + 24 +(% class="box infomessage" %) 21 21 ((( 22 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**26 +(% lang="en-US" %)**POST /api/v3/auth/login** 23 23 ))) 24 24 25 25 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. ... ... @@ -53,12 +53,14 @@ 53 53 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 54 54 55 55 60 +===== (% style="color:#000000; line-height:100%" %)**Проверка авторизации**(%%) ===== 61 + 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**64 +(% lang="en-US" %)**GET /api/v3/auth/check** 59 59 ))) 60 60 61 -(% style="color:#000000" %) 67 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 62 62 63 63 (% style="color:#000000" %)Метод запроса: **GET** 64 64 ... ... @@ -70,17 +70,17 @@ 70 70 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 71 71 72 72 73 -(% class="box" style="text-align: center;" %) 74 -((( 75 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 76 -))) 79 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Клиенты**(%%) ==== 77 77 81 + 82 +===== (% style="color:#000000" %)**Получение основных параметров клиента**(%%) ===== 83 + 78 78 (% class="box infomessage" %) 79 79 ((( 80 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**86 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 81 81 ))) 82 82 83 -(% style="color:#000000" %) 89 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 84 84 85 85 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 86 86 ... ... @@ -108,9 +108,11 @@ 108 108 } 109 109 110 110 117 +===== **Добавление клиента** ===== 118 + 111 111 (% class="box successmessage" %) 112 112 ((( 113 -** Добавление клиента —POST /api/v3/agents **121 +**POST /api/v3/agents ** 114 114 ))) 115 115 116 116 Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). ... ... @@ -168,9 +168,11 @@ 168 168 } 169 169 170 170 179 +===== **Редактирование клиента** ===== 180 + 171 171 (% class="box warningmessage" %) 172 172 ((( 173 -** Редактирование клиента —PUT /api/v3/agents**183 +**PUT /api/v3/agents** 174 174 ))) 175 175 176 176 Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). ... ... @@ -230,12 +230,13 @@ 230 230 } 231 231 232 232 243 +===== **Удаление клиента** ===== 244 + 233 233 (% class="box errormessage" %) 234 234 ((( 235 -** Удаление клиента —DELETE /api/v3/agents/{clientId}**247 +**DELETE /api/v3/agents/{clientId}** 236 236 ))) 237 237 238 - 239 239 Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 240 240 241 241 Метод запроса: **DELETE** ... ... @@ -249,18 +249,17 @@ 249 249 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 250 250 251 251 263 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Пользователи**(%%) ==== 252 252 253 -(% class="box" style="text-align: center;" %) 254 -((( 255 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 256 -))) 257 257 266 +===== (% style="color:#000000; line-height:100%" %)**Добавление пользователя**(%%) ===== 267 + 258 258 (% class="box successmessage" %) 259 259 ((( 260 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**270 +(% lang="en-US" %)**POST /api/v3/users** 261 261 ))) 262 262 263 -(% style="color:#000000" %) 273 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 264 264 265 265 (% style="color:#000000" %)Метод запроса: **POST** 266 266 ... ... @@ -319,12 +319,14 @@ 319 319 (% style="color:#000000; font-weight:normal" %)} 320 320 321 321 332 +===== (% style="color:#000000; line-height:100%" %)**Получение списка пользователей**(%%) ===== 333 + 322 322 (% class="box successmessage" %) 323 323 ((( 324 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**336 +(% lang="en-US" %)**POST /api/v3/users/find** 325 325 ))) 326 326 327 -(% style="color:#000000" %) 339 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 328 328 329 329 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 330 330 ... ... @@ -366,12 +366,14 @@ 366 366 (% style="color:#000000" %)} 367 367 368 368 381 +===== (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе**(%%) ===== 382 + 369 369 (% class="box successmessage" %) 370 370 ((( 371 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**385 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 372 372 ))) 373 373 374 -(% style="color:#000000" %) 388 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 375 375 376 376 (% style="color:#000000" %)Метод запроса: **GET** 377 377 ... ... @@ -414,12 +414,14 @@ 414 414 ))) 415 415 416 416 431 +===== (% style="color:#000000; line-height:100%" %)**Редактирование пользователя**(%%) ===== 432 + 417 417 (% class="box warningmessage" %) 418 418 ((( 419 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**435 +(% lang="en-US" %)**PUT /api/v3/users** 420 420 ))) 421 421 422 -(% style="color:#000000" %) 438 +(% 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 ... ... @@ -487,12 +487,14 @@ 487 487 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 488 488 489 489 504 +===== (% style="color:#000000" %)**Изменение статуса пользователя**(%%) ===== 505 + 490 490 (% class="box warningmessage" %) 491 491 ((( 492 -(% style="color:#000000" %) **Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**508 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 493 493 ))) 494 494 495 -(% style="color:#000000" %) 511 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 496 496 497 497 (% style="color:#000000" %)Метод запроса: **PUT** 498 498 ... ... @@ -516,9 +516,11 @@ 516 516 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 517 517 518 518 535 +===== **Блокировка пользователей** ===== 536 + 519 519 (% class="box warningmessage" %) 520 520 ((( 521 -** Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/disable**539 +**POST /api/v3/users/disable** 522 522 ))) 523 523 524 524 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). ... ... @@ -537,9 +537,11 @@ 537 537 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 538 538 539 539 558 +===== **Разблокировка пользователей** ===== 559 + 540 540 (% class="box warningmessage" %) 541 541 ((( 542 -** Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/enable**562 +**POST /api/v3/users/enable** 543 543 ))) 544 544 545 545 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). ... ... @@ -571,14 +571,16 @@ 571 571 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 572 572 "users" - массив id пользователей, которых не удалось включить или отключить. 573 573 594 + 595 +===== (% style="color:#000000; line-height:100%" %)**Удаление пользователя**(%%) ===== 574 574 ))) 575 575 576 576 (% class="box errormessage" %) 577 577 ((( 578 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**600 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 579 579 ))) 580 580 581 -(% style="color:#000000" %) 603 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 582 582 583 583 (% style="color:#000000" %)Метод запроса: **DELETE** 584 584 ... ... @@ -592,19 +592,19 @@ 592 592 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 593 593 594 594 595 -(% class="box" style="text-align: center;" %) 596 -((( 597 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 598 -))) 617 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Транспортные средства**(%%) ==== 599 599 619 + 620 +==== (% style="color:#000000; line-height:100%" %)**Получение информации об объекте**(%%) ==== 621 + 600 600 (% class="box infomessage" %) 601 601 ((( 602 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**624 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 603 603 ))) 604 604 605 -(% style="color:#000000" %) 627 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 606 606 607 -(% style="color:#000000" %) 629 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 608 608 609 609 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 610 610 ... ... @@ -666,12 +666,14 @@ 666 666 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 667 667 668 668 691 +===== (% style="color:#000000; line-height:100%" %)**Добавление объекта**(%%) ===== 692 + 669 669 (% class="box successmessage" %) 670 670 ((( 671 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**695 +(% lang="en-US" %)**POST /api/v3/vehicles** 672 672 ))) 673 673 674 -(% style="color:#000000" %) 698 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 675 675 676 676 (% style="color:#000000" %)Метод запроса: **POST** 677 677 ... ... @@ -785,14 +785,16 @@ 785 785 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 786 786 787 787 812 +===== (% style="color:#000000; line-height:100%" %)**Получение параметров объектов**(%%) ===== 813 + 788 788 (% class="box successmessage" %) 789 789 ((( 790 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**816 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 791 791 ))) 792 792 793 -(% style="color:#000000" %) 819 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 794 794 795 -(% style="color:#000000" %) 821 +(% 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" %) 858 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 833 833 834 834 (% style="color:#000000" %)Ответ: 835 835 ... ... @@ -866,12 +866,14 @@ 866 866 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 867 867 868 868 895 +===== (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(%%) ===== 896 + 869 869 (% class="box successmessage" %) 870 870 ((( 871 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**899 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 872 872 ))) 873 873 874 -(% style="color:#000000" %) 902 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 875 875 876 876 (% style="color:#000000" %)Метод запроса: **POST** 877 877 ... ... @@ -911,12 +911,14 @@ 911 911 (% style="color:#000000" %) } 912 912 913 913 942 +===== (% style="color:#000000; line-height:100%" %)**Редактирование объекта**(%%) ===== 943 + 914 914 (% class="box warningmessage" %) 915 915 ((( 916 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**946 +(% lang="en-US" %)**PUT /api/v3/vehicles** 917 917 ))) 918 918 919 -(% style="color:#000000" %) 949 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 920 920 921 921 (% style="color:#000000" %)Метод запроса: **PUT** 922 922 ... ... @@ -1039,12 +1039,14 @@ 1039 1039 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1040 1040 1041 1041 1072 +===== (% style="color:#000000; line-height:100%" %)**Удаление объекта**(%%) ===== 1073 + 1042 1042 (% class="box errormessage" %) 1043 1043 ((( 1044 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1076 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1045 1045 ))) 1046 1046 1047 -(% style="color:#000000" %) 1079 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1048 1048 1049 1049 (% style="color:#000000" %)Метод запроса: **DELETE** 1050 1050 ... ... @@ -1058,17 +1058,17 @@ 1058 1058 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1059 1059 1060 1060 1061 -(% class="box" lang="en-US" style="text-align: center;" %) 1062 -((( 1063 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1064 -))) 1093 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства** 1065 1065 1095 + 1096 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств**(%%) ===== 1097 + 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**1100 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1069 1069 ))) 1070 1070 1071 -(% style="color:#000000" %) 1103 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1072 1072 1073 1073 (% style="color:#000000" %)Метод запроса: **GET** 1074 1074 ... ... @@ -1087,17 +1087,17 @@ 1087 1087 (% style="color:#000000" %)} 1088 1088 1089 1089 1090 -(% class="box" style="text-align: center;" %) 1091 -((( 1092 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 1093 -))) 1122 +==== (% style="color:#000000; font-size:14pt" %)Раздел: **Датчики**(%%) ==== 1094 1094 1124 + 1125 +===== (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков**(%%) ===== 1126 + 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**1129 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1098 1098 ))) 1099 1099 1100 -(% style="color:#000000" %) 1132 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1101 1101 1102 1102 (% style="color:#000000" %)Метод запроса: **GET** 1103 1103