Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 47.1 >
edited by Илья Крайнов
on 2022/11/21 10:32
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" %)**Раздел Пользователи**
... ... @@ -712,7 +712,16 @@
712 712   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
713 713   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
714 714   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
715 -(% 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 + }(%%)
716 716  (% style="color:#000000" %)}
717 717  
718 718  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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