Cesar Мониторинг

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слеваПредыдущая версия
Следующая версия
Предыдущая версия
start:csp-api [2024/07/05 08:43] – cspstart:csp-api [2026/09/21 13:18] (текущий) – csp
Строка 1: Строка 1:
 ====== CSP-Api ====== ====== CSP-Api ======
  
-Для взаимодействия с Api платформы Cesar Position можно использовать сервис [[https://apicsp.csat.ru/swagger/#/| Swagger]]+Для взаимодействия с Api платформы Cesar Мониторинг можно использовать сервис [[https://apicsp.csat.ru/swagger/#/| Swagger]]
  
 Основные методы: Основные методы:
  
 **Token** **Token**
-  * POST /token - Получение токена авторизации+  * [[start:csp-api:POST /token|POST /token]] - Получение токена авторизации; 
 +  * [[start:csp-api:GET /token|GET /token-renew]] - Получение нового токена авторизации 
 +  * [[start:csp-api:Кастомная форма авторизации|Кастомная форма авторизации]]
 **Users** **Users**
-  * GET /users - Получение списка пользователей +  * [[start:csp-api:GET /users|GET /users]] - Получение списка пользователей; 
-  * POST /users - Создание пользователя +  * [[start:csp-api:POST /users|POST /users]] - Создание пользователя; 
-  * GET /users/user_id - Получение информации по пользователю +  * [[start:csp-api:GET /users/user_id|GET /users/user_id]] - Получение информации по пользователю; 
-  * DELETE /users/user_id - Удаление пользователя +  * [[start:csp-api:DELETE /users/user_id|DELETE /users/user_id]] - Удаление пользователя; 
-  * POST /users/add-units-access - Изменение прав пользователя +  * [[start:csp-api:POST /users/add-units-access|POST /users/add-units-access]] - Изменение прав пользователя для одного или нескольких объектов на чтение; 
-  * POST /users/change-password - Изменение пароля пользователя+  * [[start:csp-api:POST /users/change-password|POST /users/change-password]] - Изменение пароля пользователя; 
 +  * [[start:csp-api:PATCH /users/{user_id}/unit-access/{unit_id}|PATCH /users/{user_id}/unit-access/{unit_id}]] - Изменение всех прав пользователя на объект 
 +  * [[start:csp-api:PATCH /users/{user_id}/unit-group-access/{unit_group_id}|PATCH /users/{user_id}/unit-group-access/{unit_group_id}]] - Изменение прав пользователя на группу объектов 
 +  * [[start:csp-api:PATCH /users/{user_id}/geozone-access/{geozone_id}|PATCH /users/{user_id}/geozone-access/{geozone_id}]] - Изменение прав пользователя на геозону 
 +  * [[start:csp-api:PATCH /users/{user_id}/geozone-group-access/{geozone_group_id}|PATCH /users/{user_id}/geozone-group-access/{geozone_group_id}]] - Изменение прав пользователя на группу геозон 
 +  * [[start:csp-api:PATCH /users/{user_id}/report-access/{report_id}|PATCH /users/{user_id}/report-access/{report_id}]] - Изменение прав пользователя на отчеты
 **Units** **Units**
-  * GET /units - Получение списка объектов +  * [[start:csp-api:GET /units|GET /units]] - Получение списка объектов; 
-  * GET /units/{unit_id} - Получение информации по объекту +  * [[start:csp-api:POST /units|POST /units]] - Создание нового объекта 
-  * POST /units/device-state - +  * [[start:csp-api:GET /units/{unit_id}|GET /units/{unit_id}]]} - Получение информации по объекту; 
 +  * [[start:csp-api:PATCH /units/{unit_id}|PATCH /units/{unit_id}]] - Редактирование объекта 
 +  * [[start:csp-api:DELETE /units/{unit_id}|DELETE /units/{unit_id}]] - Удаление объекта 
 +  * [[start:csp-api:POST /units/device-state|POST /units/device-state]] - Получение полной информации по объекту; 
 +**UnitsGroups** 
 +  * [[start:csp-api:GET /units-groups|GET /units-groups]] - Получение списка групп объектов пользователя. минимальные права - чтение. 
 +  * [[start:csp-api:POST /units-groups|POST /units-groups]] - Создание новой группы объектов 
 +  * [[start:csp-api:GET /units-groups/{unit_group_id}|GET /units-groups/{unit_group_id}]] - Получение информации о группе объектов 
 +  * [[start:csp-api:PATCH /units-groups/{unit_group_id}|PATCH /units-groups/{unit_group_id}]] - Редактирование группы объектов 
 +  * [[start:csp-api:DELETE /units-groups/{unit_group_id}|DELETE /units-groups/{unit_group_id}]] - Удаление группы объектов 
 +**Geozones** 
 +  * [[.:csp-api:POST /geozones/circle|POST /geozones/circle]] - Создание геозон окружностей
 **Notifications** **Notifications**
-  * GET /notifications - получение списка уведомлений +  * [[start:csp-api:GET /notifications|GET /notifications]] - Получение списка уведомлений; 
-  * GET /notifications/{notifications_id} - получение информации по уведомлению+  * [[start:csp-api:GET /notifications/{notifications_id}|GET /notifications/{notifications_id}]] - Получение информации по уведомлению;
 **Reports** **Reports**
-  * GET /reports - Получение списка отчетов +  * [[start:csp-api:GET /reports|GET /reports]] - Получение списка отчетов; 
-  * GET /reports/{report_id} - получение информации по отчету +  * [[start:csp-api:GET /reports/{report_id}|GET /reports/{report_id}]] - Получение информации по отчету; 
-  * POST /reports/execute - выполнить отчет и получить результат+  * [[start:csp-api:POST /reports/execute|POST /reports/execute]] - Выполнить отчет и получить результат; 
 +**Locators** 
 +  * [[start:csp-api:GET /lokators|GET /locators]] - Получение списка локаторов; 
 +  * [[start:csp-api:POST /lokators/|POST /locators]] - Создание нового локатора; 
 +  * [[start:csp-api:GET /lokators/{lokators_id}|GET /locators/{locators_id}]] - Получение информации по конкретному локатору; 
 +  * [[start:csp-api:DELETE /lokators/{lokators_id}|DELETE /locators/{locators_id}]] - Удалить конкретный локатор; 
 + 
 +<WRAP important> 
 +**При выполнении отчётов через API максимальный запрашиваемый период ограничен 90 сутками. Запросы за более длительный период не поддерживаются.** 
 +</WRAP>