Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/21 14:13
<
>
edited by Андрей Калиновский
on 2025/04/21 14:04
on 2025/04/21 14:04
edited by Андрей Калиновский
on 2025/03/12 10:23
on 2025/03/12 10:23
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -11,11 +11,6 @@ 11 11 12 12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 13 14 -(% class="box infomessage" %) 15 -((( 16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 -\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 -))) 19 19 20 20 **Содержание страницы:** 21 21 ))) ... ... @@ -123,41 +123,29 @@ 123 123 Запрос должен содержать данные параметра "**agentId**" 124 124 125 125 (% style="color:#000000" %)Ответ: 126 - 127 -((( 128 128 { 129 - "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 - "parentName": "string", ~/~/ Наименование агента 132 - "name": "string", ~/~/ Имя клиента 133 - "fullName": "string", ~/~/ ФИО клиента 134 - "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 - "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 - "district": "string", ~/~/ Район 137 - "region": "string", ~/~/ Область 138 - "city": "string", ~/~/ Город 139 - "email": "string", ~/~/ Email 140 - "director": "string", ~/~/ Руководитель 141 - "RegionalData": [ ~/~/ Определяет региональные сведения. 142 - { 143 - "Country": 0, ~/~/ Страна 144 - "groups": [ ~/~/ Список групп 145 - { 146 - "groupId": "string", ~/~/ Уникальный идентификатор группы 147 - "fields": [ ~/~/ Список значений полей 148 - { 149 - "name": "string", ~/~/ Имя поля формы 150 - "value": "string" ~/~/ Значение поля формы 151 - } 152 - ] 153 - } 154 - ] 155 - } 156 - ] 157 -} 158 -))) 122 + "agentId": "", (%%) 123 + "parentId": "", 124 + "parentName": "string", 125 + "name": "string", 126 + "fullName": "string", 127 + "agentInfoType": 0, 128 + "isForeign": true/false, 129 + "district": "string", 130 + "region": "string", 131 + "city": "string", 132 + "inn": "string", 133 + "kpp": "string", 134 + "address": "string", 135 + "addressFact": "string", 136 + "email": "string", 137 + "director": "string", 138 + "bankName": "string", 139 + "bankBIK": "string", 140 + "bankRS": "string", 141 + "bankKS": "string" 142 + } 159 159 160 - 161 161 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 162 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 163 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -2529,8 +2529,6 @@ 2529 2529 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2530 2530 "fuelConsumption": 0, ~/~/ Расход топлива 2531 2531 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2532 - "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2533 - 2534 2534 } 2535 2535 ] 2536 2536 } ... ... @@ -2576,8 +2576,7 @@ 2576 2576 "model": "string", ~/~/ Модель объекта 2577 2577 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2578 2578 { 2579 - "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling 2580 - 2560 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2581 2581 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2582 2582 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2583 2583 "valueFuel": 0, ~/~/ Количество ... ... @@ -4822,51 +4822,8 @@ 4822 4822 } 4823 4823 ] 4824 4824 } 4825 - 4826 - 4827 -== **Превышение скорости** == 4828 - 4829 -(% class="box infomessage" %) 4830 -((( 4831 -**POST /api/v3/Reports/overSpeedDuration** 4832 4832 ))) 4833 4833 4834 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4835 - 4836 -Пример запроса: 4837 - 4838 -((( 4839 -{ 4840 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4841 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4842 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4843 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4844 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение; 2-фиксированный;) 4845 -} 4846 -))) 4847 - 4848 -((( 4849 - 4850 -))) 4851 - 4852 -((( 4853 -Пример ответа: 4854 -))) 4855 - 4856 -((( 4857 -((( 4858 -[ 4859 - { 4860 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4861 - "duration": 0, ~/~/ Продолжительность события в секундах 4862 - "maxSpeed": 0, ~/~/ Максимальная скорость 4863 - "speedLimit": 0 ~/~/ Ограничение скорости 4864 - } 4865 -] 4866 -))) 4867 -))) 4868 -))) 4869 - 4870 4870 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4871 4871 4872 4872 ... ... @@ -4941,16 +4941,13 @@ 4941 4941 **POST /api/v3/agroLands** 4942 4942 ))) 4943 4943 4944 -Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4945 -X-agent - ID клиента 4946 - 4947 4947 Пример запроса: 4948 4948 4949 4949 ((( 4950 4950 { 4951 4951 "extId": "string", 4952 - "shape": " {\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}",~/~/ Форма поля4953 - "shapeFormat": " geojson", ~/~/ Формат, в котором представлена форма поля4886 + "shape": "string", ~/~/ Форма поля 4887 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 4954 4954 "display": "string", ~/~/ Настройки отображения 4955 4955 "year": 0, ~/~/ Год поля 4956 4956 "name": "string", ~/~/ Наименование ... ... @@ -5992,168 +5992,7 @@ 5992 5992 5993 5993 5994 5994 5995 -= **Раздел: Яндекс Маршруты** = 5996 5996 5997 - 5998 -== **Возвращение списка маршрутов** == 5999 - 6000 -(% class="box infomessage" %) 6001 -((( 6002 -**GET /api/v3/TransportRoutes** 6003 -))) 6004 - 6005 -Пример запроса: 6006 -Id ~/~/ Идентификатор поля 6007 - 6008 - 6009 -Пример ответа: 6010 - 6011 -((( 6012 -[ 6013 - { 6014 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6015 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6016 - "name": "string", ~/~/ Наименование маршрута. 6017 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6018 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6019 - 0 6020 - ] 6021 - } 6022 -] 6023 -))) 6024 - 6025 - 6026 - 6027 -== **Добавить маршрут** == 6028 - 6029 -(% class="box infomessage" %) 6030 -((( 6031 -**POST /api/v3/TransportRoutes** 6032 -))) 6033 - 6034 -Пример запроса: 6035 -{ 6036 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6037 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6038 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6039 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6040 - 0 6041 - ] 6042 -} 6043 - 6044 - 6045 -Пример ответа: 6046 - 6047 -((( 6048 -{ 6049 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6050 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6051 - "name": "string", ~/~/ Определяет наименование маршрута 6052 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6053 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6054 - 0 6055 - ] 6056 -} 6057 -))) 6058 - 6059 - 6060 -== **Обновление маршрута** == 6061 - 6062 -(% class="box successmessage" %) 6063 -((( 6064 -**PUT /api/v3/TransportRoutes** 6065 -))) 6066 - 6067 -Пример запроса: 6068 - 6069 -((( 6070 -{ 6071 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6072 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6073 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6074 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6075 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6076 - 0 6077 - ] 6078 -} 6079 -))) 6080 - 6081 - 6082 -Пример ответа: 6083 - 6084 -((( 6085 -{ 6086 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6087 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6088 - "name": "string", ~/~/ Определяет наименование маршрута 6089 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6090 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6091 - 0 6092 - ] 6093 -} 6094 -))) 6095 - 6096 - 6097 -== **Получить связки маршрутов ТС** == 6098 - 6099 -(% class="box infomessage" %) 6100 -((( 6101 -**POST /api/v3/TransportRoutes/getroutesvehicles** 6102 -))) 6103 - 6104 -Пример запроса: 6105 - 6106 -((( 6107 -[ 6108 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6109 -] 6110 -))) 6111 - 6112 - 6113 -Пример ответа: 6114 - 6115 -((( 6116 -[ 6117 - { 6118 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6119 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6120 - } 6121 -] 6122 -))) 6123 - 6124 - 6125 -== **Удалить маршрут** == 6126 - 6127 -(% class="box warningmessage" %) 6128 -((( 6129 -**DELETE /api/v3/TransportRoutes/{id}** 6130 -))) 6131 - 6132 -Пример запроса: 6133 -Id ~/~/ Идентификатор поля 6134 - 6135 - 6136 -==== ==== 6137 - 6138 -==== **Раздел: Управление доступа к машинам** ==== 6139 - 6140 - 6141 -== Получение списка ID == 6142 - 6143 -(% class="box infomessage" %) 6144 -((( 6145 -**GET /api/v3/UserVisibleVehicles/{userId}** 6146 -))) 6147 - 6148 - 6149 - 6150 - 6151 - 6152 - 6153 - 6154 - 6155 - 6156 - 6157 6157 (% class="box" lang="en-US" style="text-align: center;" %) 6158 6158 ((( 6159 6159 (% 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]] **