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
-
... ... @@ -1,5 +1,5 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0==2 +== Описание ГЛОНАССSoft Public API == 3 3 4 4 == == 5 5 ... ... @@ -17,28 +17,40 @@ 17 17 18 18 (% class="box" style="text-align: center;" %) 19 19 ((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**20 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 21 21 ))) 22 22 23 23 (% class="box infomessage" %) 24 24 ((( 25 - ; line-height:100%" %)**Авторизация**(%style="color:#000000" %)**—**(% lang="en-US" %)**GET /api/v3/auth/login**25 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 26 26 ))) 27 27 28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации,которыйнеобходимодобавлятьвзаголовокдляработы со всеми методамиAPI.Впараметрахметодапередаетсяимяпользователяипароль.28 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 29 29 30 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 31 + 32 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 33 + 34 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 35 + 30 30 (% style="color:#000000" %)Метод запроса: **GET** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/a uth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]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> 33 33 34 -(% style="color:#000000" %) В случае успешного выполненияметода,поле«AuthId»содержиттокенавторизации «X-Auth».40 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 35 35 36 -(% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 42 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 38 38 39 - **Примечание:**Времяжизнивторизации задаетсявнастройкахпользователя,тамсть параметрдлительностьсессии.При каждомзапросетокен пролонгируется.44 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 40 40 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" %)] 41 41 48 + 49 +(% class="box" style="text-align: center;" %) 50 +((( 51 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 52 +))) 53 + 42 42 (% class="box infomessage" %) 43 43 ((( 44 44 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** ... ... @@ -56,37 +56,86 @@ 56 56 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 57 57 58 58 59 -(% class="box "style="text-align: center;" %)71 +(% class="box infomessage" %) 60 60 ((( 61 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**73 +(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 62 62 ))) 63 63 76 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 77 + 78 +(% style="color:#000000" %)Метод запроса: **GET** 79 + 80 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]] 81 + 82 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 83 + 84 +(% lang="en-US" %) 85 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 86 + 87 + 88 +(% class="box" lang="en-US" style="text-align: center;" %) 89 +((( 90 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 91 +))) 92 + 64 64 (% class="box infomessage" %) 65 65 ((( 66 -(% style="color:#000000" %)**Получение основныхпараметровклиента —**(% lang="en-US" %)**GET**(%%)**/(%lang="en-US" %)api/v3/agents(%%)**95 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 67 67 ))) 68 68 69 -(% style="color:#000000" %) Метод позволяет получить основныепараметры клиентов:наименование,полное наименование,тип, статуси идентификаторклиента-родителя. Метод возвращает информацию оклиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):98 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 70 70 71 -(% style="color:#000000" %) − информация о клиентах предоставляетсяпри наличииправа «Просмотрклиентов»;100 +(% style="color:#000000" %)Метод запроса: **GET** 72 72 73 -(% style="color:#000000" %) − возвращается информация о клиенте, которомупринадлежит авторизованныйпользователь, и его дочерних клиентах;102 +(% 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]] 74 74 75 -(% style="color:#000000" %) −информация о клиенте типа «Партнер» и егоподклиентоввозвращаетсяпри наличииправа«Доступкпартнёрским клиентам».104 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 76 76 106 +(% style="color:#000000" %)Ответ: [ 107 + 108 +(% class="western" %) 109 +{{{ { 110 + "deviceTypeId" : "", // ID типа устройства 111 + "deviceTypeName" : "" // Название типа устройства 112 + },}}} 113 + 114 +(% style="text-align:left" %) 115 +(% style="color:#000000" %)…** **] 116 + 117 + 118 +(% class="box" style="text-align: center;" %) 119 +((( 120 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 121 +))) 122 + 123 +(% class="box infomessage" %) 124 +((( 125 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 126 +))) 127 + 128 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 129 + 77 77 (% style="color:#000000" %)Метод запроса: **GET** 78 78 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>132 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 80 80 81 -(% style="color:#000000" %) Параметрзапроса:<parentId>- идентификаторклиента-родителя (опционально)134 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 82 82 83 -(% style="color:#000000" %) В заголовках запроса: X-Auth: Токен авторизации136 +(% style="color:#000000" %)Ответ: [ 84 84 85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 138 +(% class="western" style="margin-bottom:19px" %) 139 +{{{ {}}} 86 86 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" %)]141 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 88 88 143 +(% class="western" %) 144 +{{{ "description": "" // Описание 145 + },}}} 89 89 147 +(% style="text-align:left" %) 148 +(% style="color:#000000" %)… ] 149 + 150 + 90 90 (% class="box" style="text-align: center;" %) 91 91 ((( 92 92 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -440,10 +440,8 @@ 440 440 441 441 (% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 442 442 443 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 504 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null ~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 444 444 445 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 446 - 447 447 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 448 448 449 449 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] ... ... @@ -523,68 +523,5 @@ 523 523 524 524 (% class="box" lang="en-US" style="text-align: center;" %) 525 525 ((( 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 )))