Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/10 15:42
<
>
edited by Андрей Калиновский
on 2025/05/06 11:25
on 2025/05/06 11:25
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" %)Идентификатор клиента-родителя ... ... @@ -1635,8 +1635,6 @@ 1635 1635 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 1636 ))) 1637 1637 1638 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 1639 - 1640 1640 Метод запроса: **POST** 1641 1641 1642 1642 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** ... ... @@ -1672,8 +1672,6 @@ 1672 1672 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1673 1673 ))) 1674 1674 1675 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 1676 - 1677 1677 Метод запроса: **GET** 1678 1678 1679 1679 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** ... ... @@ -2533,8 +2533,6 @@ 2533 2533 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2534 2534 "fuelConsumption": 0, ~/~/ Расход топлива 2535 2535 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2536 - "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2537 - 2538 2538 } 2539 2539 ] 2540 2540 } ... ... @@ -2580,8 +2580,7 @@ 2580 2580 "model": "string", ~/~/ Модель объекта 2581 2581 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2582 2582 { 2583 - "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 2584 - 2560 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2585 2585 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2586 2586 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2587 2587 "valueFuel": 0, ~/~/ Количество ... ... @@ -2810,35 +2810,6 @@ 2810 2810 } 2811 2811 ] 2812 2812 2813 - 2814 -== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2815 - 2816 -(% class="box successmessage" %) 2817 -((( 2818 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2819 -))) 2820 - 2821 -(% style="color:#000000" %)Метод запроса: **PUT** 2822 - 2823 -Пример запроса: 2824 - 2825 -((( 2826 -{ 2827 - "id": 0, ~/~/ Идентификатор объекта геозоны 2828 - "name": "string", ~/~/ Наименование объекта геозоны 2829 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2830 - "description": "string", ~/~/ Описание объекта геозоны 2831 - "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2832 - "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2833 - "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2834 -} 2835 -))) 2836 - 2837 - 2838 -Пример ответа: 2839 - 2840 -200 ~/~/ Success 2841 - 2842 2842 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2843 2843 2844 2844 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4855,51 +4855,8 @@ 4855 4855 } 4856 4856 ] 4857 4857 } 4858 - 4859 - 4860 -== **Превышение скорости** == 4861 - 4862 -(% class="box infomessage" %) 4863 -((( 4864 -**POST /api/v3/Reports/overSpeedDuration** 4865 4865 ))) 4866 4866 4867 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4868 - 4869 -Пример запроса: 4870 - 4871 -((( 4872 -{ 4873 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4874 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4875 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4876 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4877 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4878 -} 4879 -))) 4880 - 4881 -((( 4882 - 4883 -))) 4884 - 4885 -((( 4886 -Пример ответа: 4887 -))) 4888 - 4889 -((( 4890 -((( 4891 -[ 4892 - { 4893 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4894 - "duration": 0, ~/~/ Продолжительность события в секундах 4895 - "maxSpeed": 0, ~/~/ Максимальная скорость 4896 - "speedLimit": 0 ~/~/ Ограничение скорости 4897 - } 4898 -] 4899 -))) 4900 -))) 4901 -))) 4902 - 4903 4903 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4904 4904 4905 4905 ... ... @@ -4974,16 +4974,13 @@ 4974 4974 **POST /api/v3/agroLands** 4975 4975 ))) 4976 4976 4977 -Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4978 -X-agent - ID клиента 4979 - 4980 4980 Пример запроса: 4981 4981 4982 4982 ((( 4983 4983 { 4984 4984 "extId": "string", 4985 - "shape": " {\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}",~/~/ Форма поля4986 - "shapeFormat": " geojson", ~/~/ Формат, в котором представлена форма поля4886 + "shape": "string", ~/~/ Форма поля 4887 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 4987 4987 "display": "string", ~/~/ Настройки отображения 4988 4988 "year": 0, ~/~/ Год поля 4989 4989 "name": "string", ~/~/ Наименование ... ... @@ -6025,216 +6025,7 @@ 6025 6025 6026 6026 6027 6027 6028 -= **Раздел: Яндекс Маршруты** = 6029 6029 6030 - 6031 -== **Возвращение списка маршрутов** == 6032 - 6033 -(% class="box infomessage" %) 6034 -((( 6035 -**GET /api/v3/TransportRoutes** 6036 -))) 6037 - 6038 -Пример запроса: 6039 -Id ~/~/ Идентификатор поля 6040 - 6041 - 6042 -Пример ответа: 6043 - 6044 -((( 6045 -[ 6046 - { 6047 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6048 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6049 - "name": "string", ~/~/ Наименование маршрута. 6050 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6051 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6052 - 0 6053 - ] 6054 - } 6055 -] 6056 -))) 6057 - 6058 - 6059 - 6060 -== **Добавить маршрут** == 6061 - 6062 -(% class="box infomessage" %) 6063 -((( 6064 -**POST /api/v3/TransportRoutes** 6065 -))) 6066 - 6067 -Пример запроса: 6068 -{ 6069 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6070 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6071 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6072 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6073 - 0 6074 - ] 6075 -} 6076 - 6077 - 6078 -Пример ответа: 6079 - 6080 -((( 6081 -{ 6082 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6083 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6084 - "name": "string", ~/~/ Определяет наименование маршрута 6085 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6086 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6087 - 0 6088 - ] 6089 -} 6090 -))) 6091 - 6092 - 6093 -== **Обновление маршрута** == 6094 - 6095 -(% class="box successmessage" %) 6096 -((( 6097 -**PUT /api/v3/TransportRoutes** 6098 -))) 6099 - 6100 -Пример запроса: 6101 - 6102 -((( 6103 -{ 6104 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6105 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6106 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6107 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6108 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6109 - 0 6110 - ] 6111 -} 6112 -))) 6113 - 6114 - 6115 -Пример ответа: 6116 - 6117 -((( 6118 -{ 6119 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6120 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6121 - "name": "string", ~/~/ Определяет наименование маршрута 6122 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6123 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6124 - 0 6125 - ] 6126 -} 6127 -))) 6128 - 6129 - 6130 -== **Получить связки маршрутов ТС** == 6131 - 6132 -(% class="box infomessage" %) 6133 -((( 6134 -**POST /api/v3/TransportRoutes/getroutesvehicles** 6135 -))) 6136 - 6137 -Пример запроса: 6138 - 6139 -((( 6140 -[ 6141 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6142 -] 6143 -))) 6144 - 6145 - 6146 -Пример ответа: 6147 - 6148 -((( 6149 -[ 6150 - { 6151 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6152 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6153 - } 6154 -] 6155 -))) 6156 - 6157 - 6158 -== **Удалить маршрут** == 6159 - 6160 -(% class="box warningmessage" %) 6161 -((( 6162 -**DELETE /api/v3/TransportRoutes/{id}** 6163 -))) 6164 - 6165 -Пример запроса: 6166 -Id ~/~/ Идентификатор поля 6167 - 6168 - 6169 -==== ==== 6170 - 6171 -= **Раздел: Управление доступа к машинам** = 6172 - 6173 - 6174 -== Получение списка транспортных средств видимых пользователю == 6175 - 6176 -(% class="box infomessage" %) 6177 -((( 6178 -**GET /api/v3/UserVisibleVehicles/{userId}** 6179 -))) 6180 - 6181 -Пример ответа: 6182 - 6183 -((( 6184 -{ 6185 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6186 - 0 6187 - ] 6188 -} 6189 -))) 6190 - 6191 - 6192 - 6193 -== Задает видимость транспортных средств пользователю == 6194 - 6195 -(% class="box infomessage" %) 6196 -((( 6197 -**POST /api/v3/UserVisibleVehicles** 6198 -))) 6199 - 6200 -Пример запроса: 6201 - 6202 -((( 6203 -((( 6204 -{ 6205 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6206 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6207 - 0 6208 - ] 6209 -} 6210 -))) 6211 - 6212 -((( 6213 - 6214 -))) 6215 - 6216 -((( 6217 - 6218 -))) 6219 - 6220 -((( 6221 -Пример ответа : 6222 -))) 6223 - 6224 -((( 6225 - 6226 -))) 6227 - 6228 -((( 6229 -200 ~/~/ Success 6230 -))) 6231 -))) 6232 - 6233 - 6234 - 6235 - 6236 - 6237 - 6238 6238 (% class="box" lang="en-US" style="text-align: center;" %) 6239 6239 ((( 6240 6240 (% 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]] **