Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -3,9 +3,9 @@
3	3
4	4	== ==
5	5
6		-(% class="box" style="text-align: center;" %)
	6	+(% class="box" %)
7	7	(((
8		-(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
	8	+**Действующие ограничения**
9	9	)))
10	10
11	11	(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
...	...	@@ -53,10 +53,10 @@
53	53
54	54	(% class="box infomessage" %)
55	55	(((
56		-(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
	56	+(% style="color:#000000; line-height:100%" %)**Проверка авторизации - G**(% lang="en-US" %)**ET /api/v3/auth/check**
57	57	)))
58	58
59		-(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
	59	+(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**.
60	60
61	61	(% style="color:#000000" %)Метод запроса: **GET**
62	62
...	...	@@ -65,12 +65,12 @@
65	65	(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
66	66
67	67	(% lang="en-US" %)
68		-(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
	68	+(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».
69	69
70	70
71	71	(% class="box infomessage" %)
72	72	(((
73		-(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
	73	+(% style="color:#000000; line-height:100%" %)**Авторизация — GE**(% lang="en-US" %)**T /api/v3/auth/login**
74	74	)))
75	75
76	76	(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
...	...	@@ -82,9 +82,8 @@
82	82	(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
83	83
84	84	(% lang="en-US" %)
85		-(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
	85	+(% style="color:#000000" %)Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
86	86
87		-**Примечание: **Время жизни токена авторизации задается через настройки пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
88	88
89	89	(% class="box" lang="en-US" style="text-align: center;" %)
90	90	(((
...	...	@@ -93,7 +93,7 @@
93	93
94	94	(% class="box infomessage" %)
95	95	(((
96		-(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
	95	+(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств - GE**(% lang="en-US" %)**T /api/v3/devices/types**
97	97	)))
98	98
99	99	(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
...	...	@@ -123,7 +123,7 @@
123	123
124	124	(% class="box infomessage" %)
125	125	(((
126		-(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
	125	+(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков - GE**(% lang="en-US" %)**T /api/v3/sensors/types**
127	127	)))
128	128
129	129	(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
...	...	@@ -269,7 +269,7 @@
269	269
270	270	(% class="box errormessage" %)
271	271	(((
272		-(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
	271	+(% style="color:#000000; line-height:100%" %)**Удаление объекта — D**(% lang="en-US" %)**ELETE /api/v3/vehicles/{vehicleId}**
273	273	)))
274	274
275	275	(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
...	...	@@ -469,7 +469,7 @@
469	469
470	470	(% class="box successmessage" %)
471	471	(((
472		-(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
	471	+(% style="color:#000000; line-height:100%" %)**Получение списка объектов — P**(% lang="en-US" %)**OST /api/v3/vehicles**
473	473	)))
474	474
475	475	(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
...	...	@@ -498,14 +498,8 @@
498	498
499	499	(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
500	500
501		-(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
	500	+(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307", ~/~/ IMEI (string, опционально) "sim": null,~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5 ~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null ~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
502	502
503		-(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
504		-
505		-(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
506		-
507		-(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
508		-
509	509	(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
510	510
511	511	(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
...	...	@@ -585,5 +585,5 @@
585	585
586	586	(% class="box" lang="en-US" style="text-align: center;" %)
587	587	(((
588		-(% 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]] **
	581	+(% lang="ru-RU" style="color:#000000; font-size:14pt" %)**Расширенное описание PUBLIC API 3.0 доступно по запросу на support@glonasssoft.ru**
589	589	)))