Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 76.7 >
edited by Илья Крайнов
on 2023/03/14 14:40
To version < 66.13 >
edited by Илья Крайнов
on 2022/11/24 13:40
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,14 +1,13 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -**Содержание страницы:**
4 -)))
2 += Описание ГЛОНАССSoft Public API 3.0 =
5 5  
4 +
6 6  {{toc/}}
7 7  
8 8  
9 9  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 10  
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
10 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
... ... @@ -38,7 +38,7 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}
40 +}(%%)
42 42  
43 43  
44 44  (% style="color:#000000" %)**Ответ:**
... ... @@ -75,57 +75,15 @@
75 75  
76 76  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
77 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
79 79  
80 80  (% class="box infomessage" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
81 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
84 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
86 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": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
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 -
122 -(% class="box infomessage" %)
123 -(((
124 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
125 -)))
126 -
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 -
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -132,26 +132,23 @@
132 132  
133 133  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
92 +(% style="color:#000000" %)Метод запроса: **GET**
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
94 +(% 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>
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
96 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
98 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 144  
145 145  (% style="color:#000000" %)Ответ:
146 146  
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 - Отказ)
102 +(% style="color:#000000" %){
103 + "agentId": "", ~/~/ идентификатор клиента
104 + "parentId": "", ~/~/ идентификатор клиента-родителя
105 + "name": "", ~/~/ наименование клиента
106 + "fullName": "", ~/~/ полное наименование клиента
107 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
108 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
155 155  }
156 156  
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
... ... @@ -175,7 +175,6 @@
175 175   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 179   "isForeign": true, ~/~/ иностранный контрагент
180 180   "district": "string", ~/~/ округ
181 181   "region": "string", ~/~/ регион
... ... @@ -200,7 +200,6 @@
200 200   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 201   "name": "string", ~/~/ имя
202 202   "fullName": "string", ~/~/ полное наименование
203 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 204   "isForeign": true, ~/~/ иностранный контрагент
205 205   "district": "string", ~/~/ округ
206 206   "region": "string", ~/~/ регион
... ... @@ -240,7 +240,6 @@
240 240   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 241   "name": "string", ~/~/ имя
242 242   "fullName": "string", ~/~/ полное наименование
243 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 244   "isForeign": true, ~/~/ иностранный контрагент
245 245   "district": "string", ~/~/ округ
246 246   "region": "string", ~/~/ регион
... ... @@ -369,7 +369,7 @@
369 369  
370 370  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
371 371  
372 -(% class="box infomessage" %)
323 +(% class="box successmessage" %)
373 373  (((
374 374  (% lang="en-US" %)**POST /api/v3/users/find**
375 375  )))
... ... @@ -417,7 +417,7 @@
417 417  
418 418  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
419 419  
420 -(% class="box infomessage" %)
371 +(% class="box successmessage" %)
421 421  (((
422 422  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
423 423  )))
... ... @@ -449,11 +449,8 @@
449 449   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
450 450   "description": "", ~/~/ Описание
451 451   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
452 - "doubleAuth":
453 - {
454 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
455 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
456 - },
403 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
404 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
457 457   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
458 458   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
459 459   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -503,11 +503,9 @@
503 503   "parentId": "" , ~/~/ Guid родительского агента
504 504   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
505 505   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
506 - "doubleAuth":
507 - {
508 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
509 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
510 - },
454 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
455 + "kind": "" , ~/~/ тип аутентификации
456 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
511 511   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
512 512  
513 513  (% lang="en-US" style="text-align:left" %)
... ... @@ -533,11 +533,8 @@
533 533   "isEnabled": "" , ~/~/ признак включения
534 534   "parentId": "" , ~/~/ Guid родительского агента
535 535   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
536 - "doubleAuth":
537 - {
538 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
539 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
540 - },
482 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
483 + "kind": "" , ~/~/ тип аутентификации
541 541   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
542 542   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
543 543  
... ... @@ -653,10 +653,12 @@
653 653  (% style="text-align:left" %)
654 654  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
655 655  
599 +
656 656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
657 657  
658 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
659 659  
603 +== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
604 +
660 660  (% class="box infomessage" %)
661 661  (((
662 662  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -699,8 +699,6 @@
699 699   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
700 700   "mileage": "", ~/~/ Пробег по нормам в метрах
701 701   "motohours": "" ~/~/ Моточасы по нормам, в секундах
702 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
703 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
704 704   },
705 705   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
706 706   {
... ... @@ -727,8 +727,9 @@
727 727  (% style="text-align:left" %)
728 728  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
729 729  
730 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
731 731  
674 +== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
675 +
732 732  (% class="box successmessage" %)
733 733  (((
734 734  (% lang="en-US" %)**POST /api/v3/vehicles**
... ... @@ -847,9 +847,10 @@
847 847  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
848 848  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
849 849  
850 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
851 851  
852 -(% class="box infomessage" %)
795 +== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
796 +
797 +(% class="box successmessage" %)
853 853  (((
854 854  (% lang="en-US" %)**POST /api/v3/vehicles/find**
855 855  )))
... ... @@ -929,8 +929,9 @@
929 929  
930 930  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
931 931  
932 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
933 933  
878 +== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
879 +
934 934  (% class="box successmessage" %)
935 935  (((
936 936  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
... ... @@ -975,8 +975,9 @@
975 975  (% style="text-align:left" %)
976 976  (% style="color:#000000" %) }
977 977  
978 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
979 979  
925 +== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
926 +
980 980  (% class="box warningmessage" %)
981 981  (((
982 982  (% lang="en-US" %)**PUT /api/v3/vehicles**
... ... @@ -1104,8 +1104,9 @@
1104 1104  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1105 1105  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1106 1106  
1107 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1108 1108  
1055 +== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1056 +
1109 1109  (% class="box errormessage" %)
1110 1110  (((
1111 1111  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
... ... @@ -1124,10 +1124,12 @@
1124 1124  (% style="text-align:left" %)
1125 1125  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1126 1126  
1127 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1128 1128  
1129 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1076 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1130 1130  
1078 +
1079 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1080 +
1131 1131  (% class="box infomessage" %)
1132 1132  (((
1133 1133  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
... ... @@ -1151,10 +1151,12 @@
1151 1151  (% style="text-align:left" %)
1152 1152  (% style="color:#000000" %)}
1153 1153  
1154 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1155 1155  
1156 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1105 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1157 1157  
1107 +
1108 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1109 +
1158 1158  (% class="box infomessage" %)
1159 1159  (((
1160 1160  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
... ... @@ -1166,7 +1166,7 @@
1166 1166  
1167 1167  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1168 1168  
1169 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1121 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1170 1170  
1171 1171  (% style="color:#000000" %)Ответ:
1172 1172  
... ... @@ -1179,48 +1179,7 @@
1179 1179  (% style="text-align:left" %)
1180 1180  (% style="color:#000000" %)}
1181 1181  
1182 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1183 1183  
1184 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1185 -
1186 -(% class="box infomessage" style="text-align: left;" %)
1187 -(((
1188 -**POST /api/v3/terminalMessages/count**
1189 -)))
1190 -
1191 -(% style="text-align: left;" %)
1192 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1193 -
1194 -(% style="text-align: left;" %)
1195 -Метод запроса **POST**
1196 -
1197 -(% style="text-align: left;" %)
1198 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1199 -
1200 -(% style="text-align: left;" %)
1201 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1202 -
1203 -(% style="text-align: left;" %)
1204 -{
1205 - "vehicleIds": [
1206 - id ~/~/ здесь передается список идентификаторов объектов
1207 - ],
1208 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1209 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1210 -}
1211 -
1212 -(% style="text-align: left;" %)
1213 -Ответ:
1214 -
1215 -(% style="text-align: left;" %)
1216 -[
1217 - {
1218 - "vehicleId": 0, ~/~/ идентификатор объекта
1219 - "count": 0 ~/~/ количество сообщений за период
1220 - }
1221 -]
1222 -
1223 -
1224 1224  (% class="box" lang="en-US" style="text-align: center;" %)
1225 1225  (((
1226 1226  (% 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]] **

Меню

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