Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/02/25 16:35

From version < 66.9 >

edited by Илья Крайнов
on 2022/11/24 13:34

To version < 74.1 >

edited by Илья Крайнов
on 2023/03/14 11:15

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,13 +1,14 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
--= Описание ГЛОНАССSoft Public API 3.0 =
++(((
++**Содержание страницы:**
++)))
--
  {{toc/}}
  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
--(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
++(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
@@ -37,7 +37,7 @@
  (% style="color:#000000" %){
      "login": "testuser",
      "password": "testuser"
--}(%%)
++}
  (% style="color:#000000" %)**Ответ:**
@@ -74,15 +74,57 @@
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
  (% class="box infomessage" %)
  (((
--(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
++**GET api/v3/agents/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
++
++(% style="color:#000000" %)Метод запроса: **GET**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
++
++Запрос должен содержать данные параметра "**agentId**"
++
++(% style="color:#000000" %)Ответ:
++
++{
++    "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
++    "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
++    "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
++    "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
++    "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
++    "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
++    "isForeign": true/false, ~/~/ Иностранный контрагент
++    "district": "string", ~/~/ округ
++    "region": "string", ~/~/ регион
++    "city": "string", ~/~/ город
++    "inn": "string", ~/~/ ИНН клиента
++    "kpp": "string", ~/~/ КПП клиента
++    "address": "string", ~/~/ юридический адрес
++    "addressFact": "string", ~/~/ фактический адрес
++    "email": "string", ~/~/ почта
++    "director": "string", ~/~/ ФИО руководителя
++    "bankName": "string", ~/~/ Банк
++    "bankBIK": "string", ~/~/ БИК
++    "bankRS": "string", ~/~/ Номер счета
++    "bankKS": "string" ~/~/ Корр. счет
++  }
++
++== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
++)))
++
++(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
@@ -89,28 +89,43 @@
  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
--(% style="color:#000000" %)Метод запроса: **GET**
++(% style="color:#000000" %)Метод запроса: **POST**
--(% 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>
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
--(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
++(% style="color:#000000" %)Параметр запроса:
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %){
++  "parentId": "string"
++}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--    "agentId": "",  ~/~/ идентификатор клиента
--    "parentId": "",  ~/~/ идентификатор клиента-родителя
--    "name": "",  ~/~/ наименование клиента
--    "fullName": "",  ~/~/ полное наименование клиента
--    "agentInfoType": "",  ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
--    "status": "",  ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
--}
++{
++    "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
++    "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
++    "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
++    "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
++    "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
++    "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
++    "isForeign": true/false, ~/~/ Иностранный контрагент
++    "district": "string", ~/~/ округ
++    "region": "string", ~/~/ регион
++    "city": "string", ~/~/ город
++    "inn": "string", ~/~/ ИНН клиента
++    "kpp": "string", ~/~/ КПП клиента
++    "address": "string", ~/~/ юридический адрес
++    "addressFact": "string", ~/~/ фактический адрес
++    "email": "string", ~/~/ почта
++    "director": "string", ~/~/ ФИО руководителя
++    "bankName": "string", ~/~/ Банк
++    "bankBIK": "string", ~/~/ БИК
++    "bankRS": "string", ~/~/ Номер счета
++    "bankKS": "string" ~/~/ Корр. счет
++  }
++== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
--== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
--
  (% class="box successmessage" %)
  (((
  **POST /api/v3/agents **
@@ -170,9 +170,8 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
++== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
--== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
--
  (% class="box warningmessage" %)
  (((
  **PUT /api/v3/agents**
@@ -234,9 +234,8 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
++== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
--== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
--
  (% class="box errormessage" %)
  (((
  **DELETE /api/v3/agents/{clientId}**
@@ -254,12 +254,10 @@
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
++== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
--== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
--
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/users**
@@ -323,9 +323,8 @@
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)}
++== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
--
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/users/find**
@@ -372,9 +372,8 @@
  (% style="color:#000000" %)}
++== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
--
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
@@ -422,9 +422,8 @@
  )))
  )))
++== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
--
  (% class="box warningmessage" %)
  (((
  (% lang="en-US" %)**PUT /api/v3/users**
@@ -495,9 +495,8 @@
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
++== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
--== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
--
  (% class="box warningmessage" %)
  (((
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
@@ -526,9 +526,8 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
++== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
--== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
--
  (% class="box warningmessage" %)
  (((
  **POST /api/v3/users/disable**
@@ -549,9 +549,8 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
++== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
--== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
--
  (% class="box warningmessage" %)
  (((
  **POST /api/v3/users/enable**
@@ -585,11 +585,10 @@
  }
  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
  "users" - массив id пользователей, которых не удалось включить или отключить.
--
--
--== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
  )))
++== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
++
  (% class="box errormessage" %)
  (((
  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
@@ -608,12 +608,10 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
++== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
--
  (% class="box infomessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
@@ -682,9 +682,8 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
--
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles**
@@ -803,9 +803,8 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
++== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
--
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
@@ -886,9 +886,8 @@
  (% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
++== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
--
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
@@ -933,9 +933,8 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)  }
++== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
--
  (% class="box warningmessage" %)
  (((
  (% lang="en-US" %)**PUT /api/v3/vehicles**
@@ -1063,9 +1063,8 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
++== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
--== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
--
  (% class="box errormessage" %)
  (((
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
@@ -1084,12 +1084,10 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
--(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
++== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
--
--== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
--
  (% class="box infomessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
@@ -1113,12 +1113,10 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
--= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
++== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
--
--== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
--
  (% class="box infomessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
@@ -1130,7 +1130,7 @@
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
--(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
  (% style="color:#000000" %)Ответ:
@@ -1143,7 +1143,48 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
++== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/count**
++)))
++
++(% style="text-align: left;" %)
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align: left;" %)
++{
++  "objectIds": [
++    id ~/~/ здесь передается список идентификаторов объектов
++  ],
++  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
++  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
++}
++
++(% style="text-align: left;" %)
++Ответ:
++
++(% style="text-align: left;" %)
++[
++  {
++    "id": 0, ~/~/ идентификатор объекта
++    "count": 0 ~/~/ количество сообщений за период
++  }
++]
++
++
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% 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]] **

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню