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

Summary

Details

Icon Page properties
Content
... ... @@ -1,18 +1,12 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
6 -[[ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**>>Авторизация — POST /api/v3/auth/login||anchor="Авторизация — POST /api/v3/auth/login"]]
5 +{{toc/}}
7 7  
8 8  
8 +=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) ===
9 9  
10 -
11 -(% class="box" style="text-align: center;" %)
12 -(((
13 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
14 -)))
15 -
16 16  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
17 17  
18 18  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
... ... @@ -20,17 +20,15 @@
20 20  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
21 21  
22 22  
23 -(% class="box" style="text-align: center;" %)
24 -(((
25 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
26 -)))
17 +==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ====
27 27  
19 +
28 28  (% class="box successmessage" %)
29 29  (((
30 30   (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
31 31  )))
32 32  
33 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
25 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
34 34  
35 35  (% style="color:#000000" %)Метод запроса: **POST**
36 36  
... ... @@ -116,6 +116,148 @@
116 116  }
117 117  
118 118  
111 +(% class="box successmessage" %)
112 +(((
113 +**Добавление клиента — POST /api/v3/agents **
114 +)))
115 +
116 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
117 +
118 +Метод запроса: **POST**
119 +
120 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
121 +
122 +В заголовках запроса: X-Auth: Токен авторизации
123 +
124 +Параметры в теле запроса (JSON):
125 +
126 +{
127 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
128 + "name": "string", ~/~/ имя
129 + "fullName": "string", ~/~/ полное наименование
130 + "isForeign": true, ~/~/ иностранный контрагент
131 + "district": "string", ~/~/ округ
132 + "region": "string", ~/~/ регион
133 + "city": "string", ~/~/ город
134 + "inn": "string", ~/~/ ИНН
135 + "kpp": "string", ~/~/ КПП
136 + "address": "string", ~/~/ юридический адрес
137 + "addressFact": "string", ~/~/ фактический адрес
138 + "email": "string", ~/~/ email
139 + "director": "string", ~/~/ ФИО руководителя
140 + "bankName": "string", ~/~/ банк
141 + "bankBIK": "string", ~/~/ БИК
142 + "bankRS": "string", ~/~/ номер счёта
143 + "bankKS": "string" ~/~/ корр. счёт
144 +}
145 +
146 +
147 +Ответ:
148 +
149 +{
150 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
151 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
152 + "name": "string", ~/~/ имя
153 + "fullName": "string", ~/~/ полное наименование
154 + "isForeign": true, ~/~/ иностранный контрагент
155 + "district": "string", ~/~/ округ
156 + "region": "string", ~/~/ регион
157 + "city": "string", ~/~/ город
158 + "inn": "string", ~/~/ ИНН
159 + "kpp": "string", ~/~/ КПП
160 + "address": "string", ~/~/ юридический адрес
161 + "addressFact": "string", ~/~/ фактический адрес
162 + "email": "string", ~/~/ email
163 + "director": "string", ~/~/ ФИО руководителя
164 + "bankName": "string", ~/~/ банк
165 + "bankBIK": "string", ~/~/ БИК
166 + "bankRS": "string", ~/~/ номер счёта
167 + "bankKS": "string" ~/~/ корр. счёт
168 +}
169 +
170 +
171 +(% class="box warningmessage" %)
172 +(((
173 +**Редактирование клиента — PUT /api/v3/agents**
174 +)))
175 +
176 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
177 +
178 +Метод запроса: **PUT**
179 +
180 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
181 +
182 +В заголовках запроса: X-Auth: Токен авторизации
183 +
184 +
185 +Параметры в теле запроса (JSON):
186 +
187 +{
188 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
189 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
190 + "name": "string", ~/~/ имя
191 + "fullName": "string", ~/~/ полное наименование
192 + "isForeign": true, ~/~/ иностранный контрагент
193 + "district": "string", ~/~/ округ
194 + "region": "string", ~/~/ регион
195 + "city": "string", ~/~/ город
196 + "inn": "string", ~/~/ ИНН
197 + "kpp": "string", ~/~/ КПП
198 + "address": "string", ~/~/ юридический адрес
199 + "addressFact": "string", ~/~/ фактический адрес
200 + "email": "string", ~/~/ email
201 + "director": "string", ~/~/ ФИО руководителя
202 + "bankName": "string", ~/~/ банк
203 + "bankBIK": "string", ~/~/ БИК
204 + "bankRS": "string", ~/~/ номер счёта
205 + "bankKS": "string" ~/~/ корр. счёт
206 +}
207 +
208 +
209 +Ответ:
210 +
211 +{
212 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
213 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
214 + "name": "string", ~/~/ имя
215 + "fullName": "string", ~/~/ полное наименование
216 + "isForeign": true, ~/~/ иностранный контрагент
217 + "district": "string", ~/~/ округ
218 + "region": "string", ~/~/ регион
219 + "city": "string", ~/~/ город
220 + "inn": "string", ~/~/ ИНН
221 + "kpp": "string", ~/~/ КПП
222 + "address": "string", ~/~/ юридический адрес
223 + "addressFact": "string", ~/~/ фактический адрес
224 + "email": "string", ~/~/ email
225 + "director": "string", ~/~/ ФИО руководителя
226 + "bankName": "string", ~/~/ банк
227 + "bankBIK": "string", ~/~/ БИК
228 + "bankRS": "string", ~/~/ номер счёта
229 + "bankKS": "string" ~/~/ корр. счёт
230 +}
231 +
232 +
233 +(% class="box errormessage" %)
234 +(((
235 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
236 +)))
237 +
238 +
239 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
240 +
241 +Метод запроса: **DELETE**
242 +
243 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
244 +
245 +Параметр запроса: **{clientId}** - Guid пользователя
246 +
247 +В заголовках запроса: X-Auth: Токен авторизации
248 +
249 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
250 +
251 +
252 +
119 119  (% class="box" style="text-align: center;" %)
120 120  (((
121 121  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**

Меню

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