Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 45.1 >
edited by Илья Крайнов
on 2022/11/21 10:27
To version < 59.1 >
edited by Илья Крайнов
on 2022/11/24 11:31
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,13 +1,12 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
6 -(% class="box" style="text-align: center;" %)
7 -(((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 -)))
5 +{{toc/}}
10 10  
7 +
8 +=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
9 +
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
... ... @@ -15,18 +15,13 @@
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
22 22  
23 -(% class="box successmessage" %)
24 -(((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 -)))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
20 +===== (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**(%%) =====
29 29  
22 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
23 +
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
... ... @@ -111,6 +111,148 @@
111 111  }
112 112  
113 113  
108 +(% class="box successmessage" %)
109 +(((
110 +**Добавление клиента — POST /api/v3/agents **
111 +)))
112 +
113 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
114 +
115 +Метод запроса: **POST**
116 +
117 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
118 +
119 +В заголовках запроса: X-Auth: Токен авторизации
120 +
121 +Параметры в теле запроса (JSON):
122 +
123 +{
124 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
125 + "name": "string", ~/~/ имя
126 + "fullName": "string", ~/~/ полное наименование
127 + "isForeign": true, ~/~/ иностранный контрагент
128 + "district": "string", ~/~/ округ
129 + "region": "string", ~/~/ регион
130 + "city": "string", ~/~/ город
131 + "inn": "string", ~/~/ ИНН
132 + "kpp": "string", ~/~/ КПП
133 + "address": "string", ~/~/ юридический адрес
134 + "addressFact": "string", ~/~/ фактический адрес
135 + "email": "string", ~/~/ email
136 + "director": "string", ~/~/ ФИО руководителя
137 + "bankName": "string", ~/~/ банк
138 + "bankBIK": "string", ~/~/ БИК
139 + "bankRS": "string", ~/~/ номер счёта
140 + "bankKS": "string" ~/~/ корр. счёт
141 +}
142 +
143 +
144 +Ответ:
145 +
146 +{
147 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
148 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
149 + "name": "string", ~/~/ имя
150 + "fullName": "string", ~/~/ полное наименование
151 + "isForeign": true, ~/~/ иностранный контрагент
152 + "district": "string", ~/~/ округ
153 + "region": "string", ~/~/ регион
154 + "city": "string", ~/~/ город
155 + "inn": "string", ~/~/ ИНН
156 + "kpp": "string", ~/~/ КПП
157 + "address": "string", ~/~/ юридический адрес
158 + "addressFact": "string", ~/~/ фактический адрес
159 + "email": "string", ~/~/ email
160 + "director": "string", ~/~/ ФИО руководителя
161 + "bankName": "string", ~/~/ банк
162 + "bankBIK": "string", ~/~/ БИК
163 + "bankRS": "string", ~/~/ номер счёта
164 + "bankKS": "string" ~/~/ корр. счёт
165 +}
166 +
167 +
168 +(% class="box warningmessage" %)
169 +(((
170 +**Редактирование клиента — PUT /api/v3/agents**
171 +)))
172 +
173 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
174 +
175 +Метод запроса: **PUT**
176 +
177 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
178 +
179 +В заголовках запроса: X-Auth: Токен авторизации
180 +
181 +
182 +Параметры в теле запроса (JSON):
183 +
184 +{
185 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
186 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
187 + "name": "string", ~/~/ имя
188 + "fullName": "string", ~/~/ полное наименование
189 + "isForeign": true, ~/~/ иностранный контрагент
190 + "district": "string", ~/~/ округ
191 + "region": "string", ~/~/ регион
192 + "city": "string", ~/~/ город
193 + "inn": "string", ~/~/ ИНН
194 + "kpp": "string", ~/~/ КПП
195 + "address": "string", ~/~/ юридический адрес
196 + "addressFact": "string", ~/~/ фактический адрес
197 + "email": "string", ~/~/ email
198 + "director": "string", ~/~/ ФИО руководителя
199 + "bankName": "string", ~/~/ банк
200 + "bankBIK": "string", ~/~/ БИК
201 + "bankRS": "string", ~/~/ номер счёта
202 + "bankKS": "string" ~/~/ корр. счёт
203 +}
204 +
205 +
206 +Ответ:
207 +
208 +{
209 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
210 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
211 + "name": "string", ~/~/ имя
212 + "fullName": "string", ~/~/ полное наименование
213 + "isForeign": true, ~/~/ иностранный контрагент
214 + "district": "string", ~/~/ округ
215 + "region": "string", ~/~/ регион
216 + "city": "string", ~/~/ город
217 + "inn": "string", ~/~/ ИНН
218 + "kpp": "string", ~/~/ КПП
219 + "address": "string", ~/~/ юридический адрес
220 + "addressFact": "string", ~/~/ фактический адрес
221 + "email": "string", ~/~/ email
222 + "director": "string", ~/~/ ФИО руководителя
223 + "bankName": "string", ~/~/ банк
224 + "bankBIK": "string", ~/~/ БИК
225 + "bankRS": "string", ~/~/ номер счёта
226 + "bankKS": "string" ~/~/ корр. счёт
227 +}
228 +
229 +
230 +(% class="box errormessage" %)
231 +(((
232 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
233 +)))
234 +
235 +
236 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
237 +
238 +Метод запроса: **DELETE**
239 +
240 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
241 +
242 +Параметр запроса: **{clientId}** - Guid пользователя
243 +
244 +В заголовках запроса: X-Auth: Токен авторизации
245 +
246 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
247 +
248 +
249 +
114 114  (% class="box" style="text-align: center;" %)
115 115  (((
116 116  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -245,161 +245,31 @@
245 245  (((
246 246  (((
247 247  {
248 -)))
249 -)))
250 -
251 -(((
252 -(((
253 253   "id": "", ~/~/ GUID пользователя
254 -)))
255 -)))
256 -
257 -(((
258 -(((
259 - "lastName": "", ~/~/ Фамилия
260 -)))
261 -)))
262 -
263 -(((
264 -(((
385 + "lastName": "", ~/~/ Фамилия 
265 265   "firstName": "", ~/~/ Имя
266 -)))
267 -)))
268 -
269 -(((
270 -(((
271 271   "position": "", ~/~/ Должность
272 -)))
273 -)))
274 -
275 -(((
276 -(((
277 277   "phone": "", ~/~/ Номер телефона
278 -)))
279 -)))
280 -
281 -(((
282 -(((
283 283   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 -)))
285 -)))
286 -
287 -(((
288 -(((
289 289   "parentName": "", Наименование клиента, которому принадлежит пользователь
290 -)))
291 -)))
292 -
293 -(((
294 -(((
295 295   "organization": "", ~/~/ Организация
296 -)))
297 -)))
298 -
299 -(((
300 -(((
301 301   "login": "", ~/~/ Логин пользователя
302 -)))
303 -)))
304 -
305 -(((
306 -(((
307 307   "email": "", ~/~/ Адрес электронной почты
308 -)))
309 -)))
310 -
311 -(((
312 -(((
313 313   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 -)))
315 -)))
316 -
317 -(((
318 -(((
319 319   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 -)))
321 -)))
322 -
323 -(((
324 -(((
325 325   "description": "", ~/~/ Описание
326 -)))
327 -)))
328 -
329 -(((
330 -(((
331 331   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 -)))
333 -)))
334 -
335 -(((
336 -(((
337 337   "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 -)))
339 -)))
340 -
341 -(((
342 -(((
343 343   "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 -)))
345 -)))
346 -
347 -(((
348 -(((
349 349   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 -)))
351 -)))
352 -
353 -(((
354 -(((
355 355   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 -)))
357 -)))
358 -
359 -(((
360 -(((
361 361   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 -)))
363 -)))
364 -
365 -(((
366 -(((
367 367   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 -)))
369 -)))
370 -
371 -(((
372 -(((
373 373   "groups": [], ~/~/ Список ролей пользователя
374 -)))
375 -)))
376 -
377 -(((
378 -(((
379 379   "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 -)))
381 -)))
382 -
383 -(((
384 -(((
385 385   "authDevices": [ ], ~/~/ Список авторизованных устройств
386 -)))
387 -)))
388 -
389 -(((
390 -(((
391 391   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 -)))
393 -)))
394 -
395 -(((
396 -(((
397 397   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 -)))
399 -)))
400 -
401 -(((
402 -(((
403 403  }
404 404  )))
405 405  )))
... ... @@ -613,145 +613,40 @@
613 613  
614 614  (((
615 615  {
616 -)))
617 -
618 -(((
619 619   "vehicleId": "", ~/~/ ID объекта
620 -)))
621 -
622 -(((
623 623   "name": "", ~/~/ Имя объекта
624 -)))
625 -
626 -(((
627 627   "imei": "", ~/~/ IMEI объекта
628 -)))
629 -
630 -(((
631 631   "deviceTypeId": , ~/~/ ID типа устройства
632 -)))
633 -
634 -(((
635 635   "deviceTypeName": "", ~/~/ Название типа устройства
636 -)))
637 -
638 -(((
639 639   "sim1": "", ~/~/ Номер SIM1
640 -)))
641 -
642 -(((
643 643   "parentId": "", Номер SIM2
644 -)))
645 -
646 -(((
647 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 -)))
649 -
650 -(((
629 + "parentName": "", Наименование клиента-родителя
651 651   "modelId": "", ID модели объекта
652 -)))
653 -
654 -(((
655 655   "modelName": "", Имя модели объекта
656 -)))
657 -
658 -(((
659 659   "createdAt": "", Дата создания объекта
660 -)))
661 -
662 -(((
663 663   "mileageCalcMethod": "", Выбранный метод расчета пробега
664 -)))
665 -
666 -(((
667 667   "counters": { ~/~/ Нормы
668 -)))
669 -
670 -(((
671 671   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 -)))
673 -
674 -(((
675 675   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 -)))
677 -
678 -(((
679 679   "mileage": "", ~/~/ Пробег по нормам в метрах
680 -)))
681 -
682 -(((
683 683   "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 -)))
685 -
686 -(((
687 687   },
688 -)))
689 -
690 -(((
691 691   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 -)))
693 -
694 -(((
695 695   {
696 -)))
697 -
698 -(((
699 - "id": "", ~/~/ ID  задания
700 -)))
701 -
702 -(((
642 + "id": "", ~/~/ ID  задания
703 703   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 -)))
705 -
706 -(((
707 707   "name": "", ~/~/ Наименование задания
708 -)))
709 -
710 -(((
711 711   "description": "", ~/~/ Описание задания
712 -)))
713 -
714 -(((
715 715   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 -)))
717 -
718 -(((
719 719   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 -)))
721 -
722 -(((
723 723   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 -)))
725 -
726 -(((
727 727   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 -)))
729 -
730 -(((
731 731   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 -)))
733 -
734 -(((
735 735   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 -)))
737 -
738 -(((
739 739   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 -)))
741 -
742 -(((
743 743   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 -)))
745 -
746 -(((
747 747   }
748 -)))
749 -
750 -(((
751 751   ]
752 -)))
753 -
754 -(((
755 755  }
756 756  )))
757 757  
... ... @@ -914,7 +914,6 @@
914 914  
915 915  (% style="color:#000000" %)Параметры в теле запроса (JSON):
916 916  
917 -
918 918  {
919 919   "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
920 920   "name": null, ~/~/ Имя ТС (string, опционально)
... ... @@ -922,15 +922,10 @@
922 922   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
923 923   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
924 924   "parentId": null, ~/~/ ID клиента (Guid, опционально)
925 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
926 - "customFields\": null ~/~/ значение любого из произвольных полей ТС
825 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
826 + "customFields": null ~/~/ значение любого из произвольных полей ТС
927 927  }
928 928  
929 -
930 -(((
931 -
932 -)))
933 -
934 934  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
935 935  
936 936  (% style="color:#000000" %)Ответ:
... ... @@ -953,7 +953,16 @@
953 953   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
954 954   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
955 955   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
956 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
851 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
852 + "customFields": [ 
853 + {
854 + "id": "", ~/~/ идентификатор произвольного поля
855 + "name": "", ~/~/ имя произвольного поля
856 + "value": "", ~/~/ значение произвольного поля
857 + "forClient": true, ~/~/ право на отображение у клиента
858 + "forTooltip": false, ~/~/ право на отображение в подсказке
859 + "forReport": false ~/~/ право на отображение в отчетах
860 + }(%%)
957 957  (% style="color:#000000" %)}
958 958  
959 959  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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