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

Summary

Details

Icon Page properties
Content
... ... @@ -3,12 +3,17 @@
3 3  **Содержание страницы:**
4 4  )))
5 5  
6 +(% class="western" %)
7 +(((
8 +
9 +)))
10 +
6 6  {{toc/}}
7 7  
8 8  
9 9  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 10  
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
16 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
... ... @@ -75,57 +75,15 @@
75 75  
76 76  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
83 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
79 79  
80 80  (% class="box infomessage" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
87 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
90 +(% 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**
98 +(% style="color:#000000" %)Метод запроса: **GET**
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
100 +(% 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" %)Параметр запроса:
102 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
104 +(% 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 - Отказ)
108 +(% style="color:#000000" %){
109 + "agentId": "", ~/~/ идентификатор клиента
110 + "parentId": "", ~/~/ идентификатор клиента-родителя
111 + "name": "", ~/~/ наименование клиента
112 + "fullName": "", ~/~/ полное наименование клиента
113 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
114 + "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" %)
329 +(% 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" %)
377 +(% 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 - },
409 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
410 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
457 457   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
458 458   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
459 459   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -496,9 +496,7 @@
496 496   "phone": "" , ~/~/ телефон
497 497   "organization": "" , ~/~/ организация
498 498   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
499 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
500 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
501 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
453 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
502 502   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
503 503  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
504 504   "isEnabled": "" , ~/~/ признак включения
... ... @@ -505,12 +505,9 @@
505 505   "parentId": "" , ~/~/ Guid родительского агента
506 506   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
507 507   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
508 - "doubleAuth":
509 - {
510 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
511 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
512 - },
513 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
460 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
461 + "kind": "" , ~/~/ тип аутентификации
462 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
514 514   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
515 515  
516 516  (% lang="en-US" style="text-align:left" %)
... ... @@ -536,12 +536,8 @@
536 536   "isEnabled": "" , ~/~/ признак включения
537 537   "parentId": "" , ~/~/ Guid родительского агента
538 538   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
539 - "doubleAuth":
540 - {
541 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
542 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
543 - },
544 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
488 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
489 + "kind": "" , ~/~/ тип аутентификации
545 545   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
546 546   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
547 547  
... ... @@ -703,8 +703,6 @@
703 703   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
704 704   "mileage": "", ~/~/ Пробег по нормам в метрах
705 705   "motohours": "" ~/~/ Моточасы по нормам, в секундах
706 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
707 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
708 708   },
709 709   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
710 710   {
... ... @@ -853,7 +853,7 @@
853 853  
854 854  == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
855 855  
856 -(% class="box infomessage" %)
799 +(% class="box successmessage" %)
857 857  (((
858 858  (% lang="en-US" %)**POST /api/v3/vehicles/find**
859 859  )))
... ... @@ -1170,7 +1170,7 @@
1170 1170  
1171 1171  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1172 1172  
1173 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1116 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1174 1174  
1175 1175  (% style="color:#000000" %)Ответ:
1176 1176  
... ... @@ -1183,48 +1183,7 @@
1183 1183  (% style="text-align:left" %)
1184 1184  (% style="color:#000000" %)}
1185 1185  
1186 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1187 1187  
1188 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1189 -
1190 -(% class="box infomessage" style="text-align: left;" %)
1191 -(((
1192 -**POST /api/v3/terminalMessages/count**
1193 -)))
1194 -
1195 -(% style="text-align: left;" %)
1196 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1197 -
1198 -(% style="text-align: left;" %)
1199 -Метод запроса **POST**
1200 -
1201 -(% style="text-align: left;" %)
1202 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1203 -
1204 -(% style="text-align: left;" %)
1205 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1206 -
1207 -(% style="text-align: left;" %)
1208 -{
1209 - "vehicleIds": [
1210 - id ~/~/ здесь передается список идентификаторов объектов
1211 - ],
1212 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1213 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1214 -}
1215 -
1216 -(% style="text-align: left;" %)
1217 -Ответ:
1218 -
1219 -(% style="text-align: left;" %)
1220 -[
1221 - {
1222 - "vehicleId": 0, ~/~/ идентификатор объекта
1223 - "count": 0 ~/~/ количество сообщений за период
1224 - }
1225 -]
1226 -
1227 -
1228 1228  (% class="box" lang="en-US" style="text-align: center;" %)
1229 1229  (((
1230 1230  (% 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 г.