Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -11,6 +11,11 @@ 11 11 12 12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 13 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 14 14 15 15 **Содержание страницы:** 16 16 ))) ... ... @@ -118,29 +118,41 @@ 118 118 Запрос должен содержать данные параметра "**agentId**" 119 119 120 120 (% style="color:#000000" %)Ответ: 126 + 127 +((( 121 121 { 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 - } 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 +))) 143 143 160 + 144 144 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 145 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 146 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -2512,6 +2512,8 @@ 2512 2512 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2513 2513 "fuelConsumption": 0, ~/~/ Расход топлива 2514 2514 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2532 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2533 + 2515 2515 } 2516 2516 ] 2517 2517 } ... ... @@ -2557,7 +2557,8 @@ 2557 2557 "model": "string", ~/~/ Модель объекта 2558 2558 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2559 2559 { 2560 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 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 + 2561 2561 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2562 2562 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2563 2563 "valueFuel": 0, ~/~/ Количество ... ... @@ -4878,13 +4878,16 @@ 4878 4878 **POST /api/v3/agroLands** 4879 4879 ))) 4880 4880 4901 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4902 +X-agent - ID клиента 4903 + 4881 4881 Пример запроса: 4882 4882 4883 4883 ((( 4884 4884 { 4885 4885 "extId": "string", 4886 - "shape": " string", ~/~/ Форма поля4887 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля4909 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4910 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4888 4888 "display": "string", ~/~/ Настройки отображения 4889 4889 "year": 0, ~/~/ Год поля 4890 4890 "name": "string", ~/~/ Наименование ... ... @@ -5812,7 +5812,7 @@ 5812 5812 5813 5813 (% class="box infomessage" %) 5814 5814 ((( 5815 -**GET/api/v3/locators** 5838 +**GET /api/v3/locators** 5816 5816 ))) 5817 5817 5818 5818 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5852,7 +5852,7 @@ 5852 5852 5853 5853 (% class="box successmessage" %) 5854 5854 ((( 5855 -** GET/api/v3/locators**5878 +**POST /api/v3/locators** 5856 5856 ))) 5857 5857 5858 5858 Пример запроса: ... ... @@ -5884,7 +5884,7 @@ 5884 5884 5885 5885 (% class="box infomessage" %) 5886 5886 ((( 5887 -**PUT/api/v3/locators** 5910 +**PUT /api/v3/locators** 5888 5888 ))) 5889 5889 5890 5890 Пример запроса: ... ... @@ -5913,7 +5913,7 @@ 5913 5913 5914 5914 (% class="box warningmessage" %) 5915 5915 ((( 5916 -** PUT/api/v3/locators**5939 +**DELETE /api/v3/locators** 5917 5917 ))) 5918 5918 5919 5919 Пример запроса: ... ... @@ -5926,7 +5926,148 @@ 5926 5926 5927 5927 5928 5928 5952 += **Раздел: Яндекс Маршруты** = 5929 5929 5954 + 5955 +== **Возвращение списка маршрутов** == 5956 + 5957 +(% class="box infomessage" %) 5958 +((( 5959 +**GET /api/v3/TransportRoutes** 5960 +))) 5961 + 5962 +Пример запроса: 5963 +Id ~/~/ Идентификатор поля 5964 + 5965 + 5966 +Пример ответа: 5967 + 5968 +((( 5969 +[ 5970 + { 5971 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 5972 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 5973 + "name": "string", ~/~/ Наименование маршрута. 5974 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 5975 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 5976 + 0 5977 + ] 5978 + } 5979 +] 5980 +))) 5981 + 5982 + 5983 + 5984 +== **Добавить маршрут** == 5985 + 5986 +(% class="box infomessage" %) 5987 +((( 5988 +**POST /api/v3/TransportRoutes** 5989 +))) 5990 + 5991 +Пример запроса: 5992 +{ 5993 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 5994 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 5995 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 5996 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 5997 + 0 5998 + ] 5999 +} 6000 + 6001 + 6002 +Пример ответа: 6003 + 6004 +((( 6005 +{ 6006 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6007 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6008 + "name": "string", ~/~/ Определяет наименование маршрута 6009 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6010 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6011 + 0 6012 + ] 6013 +} 6014 +))) 6015 + 6016 + 6017 +== **Обновление маршрута** == 6018 + 6019 +(% class="box successmessage" %) 6020 +((( 6021 +**PUT /api/v3/TransportRoutes** 6022 +))) 6023 + 6024 +Пример запроса: 6025 + 6026 +((( 6027 +{ 6028 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6029 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6030 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6031 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6032 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6033 + 0 6034 + ] 6035 +} 6036 +))) 6037 + 6038 + 6039 +Пример ответа: 6040 + 6041 +((( 6042 +{ 6043 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6045 + "name": "string", ~/~/ Определяет наименование маршрута 6046 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6047 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6048 + 0 6049 + ] 6050 +} 6051 +))) 6052 + 6053 + 6054 +== **Получить связки маршрутов ТС** == 6055 + 6056 +(% class="box infomessage" %) 6057 +((( 6058 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6059 +))) 6060 + 6061 +Пример запроса: 6062 + 6063 +((( 6064 +[ 6065 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6066 +] 6067 +))) 6068 + 6069 + 6070 +Пример ответа: 6071 + 6072 +((( 6073 +[ 6074 + { 6075 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6076 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6077 + } 6078 +] 6079 +))) 6080 + 6081 + 6082 +== **Удалить маршрут** == 6083 + 6084 +(% class="box warningmessage" %) 6085 +((( 6086 +**DELETE /api/v3/TransportRoutes/{id}** 6087 +))) 6088 + 6089 +Пример запроса: 6090 +Id ~/~/ Идентификатор поля 6091 + 6092 + 6093 + 5930 5930 (% class="box" lang="en-US" style="text-align: center;" %) 5931 5931 ((( 5932 5932 (% 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]] **