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

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

From version < 78.1 >

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

To version < 69.1 >

edited by Илья Крайнов
on 2022/11/30 14:00

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -8,7 +8,7 @@
  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
--(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
++(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
@@ -75,57 +75,15 @@
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
  (% class="box infomessage" %)
  (((
--**GET api/v3/agents/{id}**
++(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
  )))
--Метод позволяет получить параметры выбранного клиента(% 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": "", ~/~/ идентификатор клиента    (%%)
--    "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" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
@@ -132,26 +132,23 @@
  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
--(% style="color:#000000" %)Метод запроса: **POST**
++(% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
++(% 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" %)Параметр запроса:
++(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
--(% style="color:#000000" %){
--  "parentId": "string"
--}
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
  (% 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 - Договор)
--    "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
++(% 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 - Отказ)
  }
  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
@@ -175,7 +175,6 @@
     "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
--  "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
    "isForeign": true, ~/~/ иностранный контрагент
    "district": "string", ~/~/ округ
    "region": "string", ~/~/ регион
@@ -200,7 +200,6 @@
    "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
--  "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
    "isForeign": true, ~/~/ иностранный контрагент
    "district": "string", ~/~/ округ
    "region": "string", ~/~/ регион
@@ -240,7 +240,6 @@
    "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
--  "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
    "isForeign": true, ~/~/ иностранный контрагент
    "district": "string", ~/~/ округ
    "region": "string", ~/~/ регион
@@ -319,8 +319,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %)
--{
++(% style="color:#000000" %){
      "lastName": "",  ~/~/ фамилия
      "firstName": "",  ~/~/ имя
      "position": "",  ~/~/ должность
@@ -329,41 +329,17 @@
      "login": "",  ~/~/ логин (обязателен)
      "password": "",  ~/~/ пароль (обязателен)
      "email": "",  ~/~/ email (обязателен)
--    "description": "string", ~/~/ Описание
--    "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
--    "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
--    "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
++    "description": "",  ~/~/ описание
++    "isEnabled": "",  ~/~/ признак включения
      "parentId": "",  ~/~/ Guid родительского агента
--    "leaderId": "",  ~/~/ Guid руководителя (null - не задан)
--    "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
--    "doubleAuth":
--    {
--       "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
--       "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
--    },
--    "groups":
--    [
--       "string" ~/~/ группы пользователя, перечисление названия системных ролей
--    ],
--    "customGroups":
--    [
--       "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
--    ],
--    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "leaderId": "",  ~/~/ Guid руководителя (null - не задан)
++    "sessionDuration": "",  ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
++    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
++    "kind": "",  ~/~/ тип аутентификации (None - выключена, Email - по email)
++    "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
++    "groups": ["", ""] ,  ~/~/ группы пользователя, перечисление названия групп (data-row)
  }
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "lastName": "string",
--  "firstName": "string",
--  "position": "string",
--  "phone": "string",
--  "organization": "string",
--  "login": "string",
--  "password": "string",
--  "email": "string",
--
--
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
@@ -394,7 +394,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
--(% class="box infomessage" %)
++(% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/users/find**
  )))
@@ -442,7 +442,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
--(% class="box infomessage" %)
++(% class="box successmessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
  )))
@@ -474,11 +474,8 @@
      "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
      "description": "", ~/~/ Описание
      "isEnabled": , ~/~/ Включен, true - включен, false - отключен
--    "doubleAuth":
--    {
--        "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
--        "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
--    },
++    "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
++    "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "sessionDuration": 30, ~/~/ Длительность сессии в минутах
      "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
@@ -521,9 +521,7 @@
      "phone": "" ,  ~/~/ телефон
      "organization": "" ,  ~/~/ организация
      "login": "" ,  ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "password": "" ,  ~/~/ пароль (Если null - менять не надо)
--    "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
--    "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "password": "" ,  ~/~/ пароль (Если null - менять не надо)
      "email": "" ,  ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "description": "" ,  ~/~/ описание
      "isEnabled": "" ,  ~/~/ признак включения
@@ -530,12 +530,9 @@
      "parentId": "" ,  ~/~/ Guid родительского агента
      "leaderId": "" ,  ~/~/ Guid руководителя (null - не задан)
      "sessionDuration": "" ,  ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
--    "doubleAuth":
--    {
--        "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
--        "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
--    },
--    "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
++    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
++    "kind": "" ,  ~/~/ тип аутентификации
++    "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
  (% lang="en-US" style="text-align:left" %)
@@ -561,12 +561,8 @@
      "isEnabled": "" ,  ~/~/ признак включения
      "parentId": "" ,  ~/~/ Guid родительского агента
      "sessionDuration": "" ,  ~/~/ продолжительность сессии, в минутах
--    "doubleAuth":
--    {
--        "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
--        "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
--    },
--    "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
++    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
++    "kind": "" ,  ~/~/ тип аутентификации
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
@@ -728,8 +728,6 @@
          "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
          "mileage": "", ~/~/ Пробег по нормам в метрах
          "motohours": "" ~/~/ Моточасы по нормам, в секундах
--        "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
--        "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
      },
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
@@ -878,7 +878,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
--(% class="box infomessage" %)
++(% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
@@ -1195,7 +1195,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" %)Ответ:
@@ -1208,48 +1208,7 @@
  (% 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;" %)
--{
--  "vehicleIds": [
--    id ~/~/ здесь передается список идентификаторов объектов
--  ],
--  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
--  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
--}
--
--(% style="text-align: left;" %)
--Ответ:
--
--(% style="text-align: left;" %)
--[
--  {
--    "vehicleId": 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

Меню