Summary

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

Details

Page properties

Content

...	...	@@ -8,7 +8,7 @@
8	8
9	9	= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10	10
11		-(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
	11	+(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12	12
13	13	(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14	14
...	...	@@ -75,15 +75,57 @@
75	75
76	76	= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77	77
78		-== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
	78	+== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79	79
80	80	(% class="box infomessage" %)
81	81	(((
82		-(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
	82	+**GET api/v3/agents/{id}**
83	83	)))
84	84
85		-(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
	85	+Метод позволяет получить параметры выбранного клиента(% 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	+
87	87	(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
88	88
89	89	(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
...	...	@@ -90,24 +90,40 @@
90	90
91	91	(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
92	92
93		-(% style="color:#000000" %)Метод запроса: **GET**
	135	+(% style="color:#000000" %)Метод запроса: **POST**
94	94
95		-(% 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>
	137	+(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
96	96
97		-(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
	139	+(% style="color:#000000" %)Параметр запроса:
98	98
99		-(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
	141	+(% style="color:#000000" %){
	142	+ "parentId": "string"
	143	+}
100	100
101	101	(% style="color:#000000" %)Ответ:
102	102
103		-(% style="color:#000000" %){
104		- "agentId": "", ~/~/ идентификатор клиента
105		- "parentId": "", ~/~/ идентификатор клиента-родителя
106		- "name": "", ~/~/ наименование клиента
107		- "fullName": "", ~/~/ полное наименование клиента
108		- "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
109		- "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
110		-}
	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	+ "isForeign": true/false, ~/~/ Иностранный контрагент
	155	+ "district": "string", ~/~/ округ
	156	+ "region": "string", ~/~/ регион
	157	+ "city": "string", ~/~/ город
	158	+ "inn": "string", ~/~/ ИНН клиента
	159	+ "kpp": "string", ~/~/ КПП клиента
	160	+ "address": "string", ~/~/ юридический адрес
	161	+ "addressFact": "string", ~/~/ фактический адрес
	162	+ "email": "string", ~/~/ почта
	163	+ "director": "string", ~/~/ ФИО руководителя
	164	+ "bankName": "string", ~/~/ Банк
	165	+ "bankBIK": "string", ~/~/ БИК
	166	+ "bankRS": "string", ~/~/ Номер счета
	167	+ "bankKS": "string" ~/~/ Корр. счет
	168	+ }
111	111
112	112	== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113	113
...	...	@@ -1108,7 +1108,7 @@
1108	1108
1109	1109	(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1110	1110
1111		-(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
	1169	+(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1112	1112
1113	1113	(% style="color:#000000" %)Ответ:
1114	1114
...	...	@@ -1121,7 +1121,48 @@
1121	1121	(% style="text-align:left" %)
1122	1122	(% style="color:#000000" %)}
1123	1123
	1182	+= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1124	1124
	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	+ "objectIds": [
	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	+ "id": 0, ~/~/ идентификатор объекта
	1219	+ "count": 0 ~/~/ количество сообщений за период
	1220	+ }
	1221	+]
	1222	+
	1223	+
1125	1125	(% class="box" lang="en-US" style="text-align: center;" %)
1126	1126	(((
1127	1127	(% 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]] **