Commit ca843c
2026-10-01 13:16:35 GitLab Sync: sync: pull wiki from dev| админ-панель/глобальный поиск.md .. | |
| @@ 4,7 4,7 @@ | |
| Глобальный поиск состоит из блока поиска со строкой поиска и фильтром по сущностям | |
| - |  |
| + |  |
| Для уточнения поиска выберите фильтр типа сущности, затем введите запрос в строку поиска. Нажмите на **три точки**, чтобы открыть список доступных действий». | |
| админ-панель/глобальный поиск/img-глобальный поиск-1.png .. /dev/null | |
| /dev/null .. админ-панель/глобальный поиск/img-глобальный поиск.png | |
| админ-панель/импорт и экспорт.md .. | |
| @@ 8,6 8,8 @@ | |
| 2. Данных полученных от терминалов | |
| 3. ТО (технического обслуживания) | |
| + |  |
| + | |
| Экспортировать из Админ-панели на текущий момент можно только историю объектов (данные) | |
| Так же для комфортного перехода в SKIF.PRO реализован функционал [общего импорта](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C/%D0%B8%D0%BC%D0%BF%D0%BE%D1%80%D1%82%20%D0%B8%20%D1%8D%D0%BA%D1%81%D0%BF%D0%BE%D1%80%D1%82/%D0%BE%D0%B1%D1%89%D0%B8%D0%B9%20%D0%B8%D0%BC%D0%BF%D0%BE%D1%80%D1%82%20%D0%B8%D0%B7%20wialon), позволяющий автоматически перенести пользователей, объекты, группы объектов, геозоны и сообщения из Wialon. | |
| \ | No newline at end of file |
| /dev/null .. админ-панель/импорт и экспорт/img-импорт и экспорт.png | |
| админ-панель/компании и сущности.md .. | |
| @@ 2,9 2,9 @@ | |
| Понятия компании и сущности тесно связаны, однако между ними есть существенные отличия. | |
| - | Компания — это часть системы, которая представляет собой пространство для взаимодействия с сущностями (объектами, геозонами, уведомлениями и т.д). Компания создаётся автоматически одновременно с созданием учетной записи, так как учетная запись не может существовать без компании. Кроме того, Вы можете вручную создавать дополнительные компании для Вашей учетной записи. Это может быть полезно тогда, когда Вы хотите предоставить доступ к разным сущностям для разных пользователей. |
| + | **Компания** — это часть системы, которая представляет собой пространство для взаимодействия с сущностями (объектами, геозонами, уведомлениями и т.д). Компания создаётся автоматически одновременно с созданием учетной записи, так как учетная запись не может существовать без компании. Кроме того, Вы можете вручную создавать дополнительные компании для Вашей учетной записи. Это может быть полезно тогда, когда Вы хотите предоставить доступ к разным сущностям для разных пользователей. |
| - | Сущность — это центральный элемент для действий. Большинство действий в системе завязаны именно на сущности. |
| + | **Сущность** — это центральный элемент для действий. Большинство действий в системе завязаны именно на сущности. |
| Вы можете взаимодействовать с сущностями различными способами, например: | |
| - **Просматривать** их в общих списках с быстрым поиском. | |
| админ-панель/компании и сущности/настройки компании.md .. | |
| @@ 44,6 44,6 @@ | |
| Модуль **пользователи** предназначен для добавления доступных пользователей в Ваши компании, а так же установки для них **Ролей доступа**. | |
| - |  |
| + |  |
| Здесь Вы можете выбрать ранее [созданного](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C/%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B8/%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5%20%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F%20%D0%B2%20%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D0%B8) пользователя и добавить его в необходимую компанию, назначив ему необходимые ограничения через [роли пользователей](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0/%D1%80%D0%BE%D0%BB%D0%B8%20%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9). | |
| \ | No newline at end of file |
| /dev/null .. админ-панель/компании и сущности/настройки компании/img-настройки компании-2.png | |
| админ-панель/компании и сущности/настройки компании/img-настройки компании-5.png .. /dev/null | |
| админ-панель/объекты/img-объекты.png .. | |
| админ-панель/основные понятия.md .. | |
| @@ 2,19 2,19 @@ | |
| Для понимания связей между элементами в системе управления ознакомьтесь со следующими основными понятиями: | |
| - | | Понятие | Описание | |
| - | | :------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |
| - | | Сущность | Сущности установлением взаимосвязей которых занимается система мониторинга, зачастую могут быть представлены в качестве срок справочников. | |
| - | | Модули системы | Справочники, органы управления и вывода информации. | |
| - | | Интегратор | Под интегратором понимается компания, которая оказывает услуги по интеграции платформ мониторинга и/или соответствующего оборудования другим компаниям. | |
| - | | Компания | Основная сущность в системе. Именно компаниям принадлежат объекты, терминалы, и другие сущности. | |
| - | | Сотрудник | Сотрудник интегратора, с административными правами добавляется и настраивается в [**Админ-панели**](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C) | |
| - | | Пользователь | Конечный пользователь системы, роли от администратора и ниже | |
| - | | Роль пользователя | Набор прав для доступа к сущностям и действиям с ними,роль настраивается в системе мониторинга в центре управления и присваивается в меню редактирования пользователя | |
| - | | Объект | Транспортное средство (реже человек или животное), либо стационарный объект, по которому собираются и обрабатываются данные. Основная сущность мониторинга. | |
| - | | Терминал | [GPS- и ГЛОНАСС-оборудование](/%D0%BE%D0%B1%D0%BE%D1%80%D1%83%D0%B4%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5/%D0%BF%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BE%D0%B1%D0%BE%D1%80%D1%83%D0%B4%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F) установленное на объект. | |
| - | | Сообщение | Единичная запись пришедшая от терминала (точка), представляет из себя строку данных с параметрами. | |
| - | | Параметры | Информация передаваемая в полях сообщений терминала. <br>Параметры разбираются системой для вывода через датчики, либо напрямую в поля отчетов, в аннотацию мониторинга, в точки трека и т.д. | |
| - | | Тариф | [Абонентская плата](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C/%D0%B1%D0%B8%D0%BB%D0%BB%D0%B8%D0%BD%D0%B3%20%D0%B8%20%D1%82%D0%B0%D1%80%D0%B8%D1%84%D1%8B/%D1%82%D0%B8%D0%BF%D1%8B%20%D1%82%D0%B0%D1%80%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%B8) за доступ к платформе для одного транспортного средства или другого объекта мониторинга | |
| - | | Ретрансляция | Пересылка данных объекта на сторонний сервер или сервис | |
| - | | Ретрансляция исторических данных | Пересылка данных объекта на сторонний или внешний сервис за определенный период времени. | |
| + | | Понятие | Описание | |
| + | |----|----| |
| + | | Сущность | Сущности установлением взаимосвязей которых занимается система мониторинга, зачастую могут быть представлены в качестве срок справочников. | |
| + | | Модули системы | Справочники, органы управления и вывода информации. | |
| + | | Интегратор | Под интегратором понимается компания, которая оказывает услуги по интеграции платформ мониторинга и/или соответствующего оборудования другим компаниям. | |
| + | | Компания | Основная сущность в системе. Именно компаниям принадлежат объекты, терминалы, и другие сущности. | |
| + | | Сотрудник | Сотрудник интегратора, с административными правами добавляется и настраивается в [**Админ-панели**](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C) | |
| + | | [Пользователи](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C/%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B8) | Конечный пользователь системы, роли от администратора и ниже | |
| + | | [Роли пользователей](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0/%D1%80%D0%BE%D0%BB%D0%B8%20%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9) | Набор прав для доступа к сущностям и действиям с ними,роль настраивается в системе мониторинга в центре управления и присваивается в меню редактирования пользователя | |
| + | | [Объект](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0/%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B%20%D0%B2%20%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0) | Транспортное средство (реже человек или животное), либо стационарный объект, по которому собираются и обрабатываются данные. Основная сущность мониторинга. | |
| + | | Терминал | [GPS- и ГЛОНАСС-оборудование](/%D0%BE%D0%B1%D0%BE%D1%80%D1%83%D0%B4%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5/%D0%BF%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5%20%D0%BE%D0%B1%D0%BE%D1%80%D1%83%D0%B4%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F) установленное на объект. | |
| + | | Сообщение | Единичная запись пришедшая от терминала (точка), представляет из себя строку данных с параметрами. | |
| + | | Параметры | Информация передаваемая в полях сообщений терминала. <br>Параметры разбираются системой для вывода через датчики, либо напрямую в поля отчетов, в аннотацию мониторинга, в точки трека и т.д. | |
| + | | Тариф | [Абонентская плата](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C/%D0%B1%D0%B8%D0%BB%D0%BB%D0%B8%D0%BD%D0%B3%20%D0%B8%20%D1%82%D0%B0%D1%80%D0%B8%D1%84%D1%8B/%D1%82%D0%B8%D0%BF%D1%8B%20%D1%82%D0%B0%D1%80%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D0%B8) за доступ к платформе для одного транспортного средства или другого объекта мониторинга | |
| + | | Ретрансляция | Пересылка данных объекта на сторонний сервер или сервис | |
| + | | [Ретрансляция исторических данных](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C/%D1%80%D0%B5%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BB%D1%8F%D1%86%D0%B8%D0%B8/%D1%80%D0%B5%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BB%D1%8F%D1%86%D0%B8%D1%8F%20%D0%B8%D1%81%D1%82%D0%BE%D1%80%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D1%85%20%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85) | Пересылка данных объекта на сторонний или внешний сервис за определенный период времени. | |
| админ-панель/пользователи/img-пользователи.png .. | |
| админ-панель/пользователи/настройки сотрудника.md .. | |
| @@ 10,7 10,7 @@ | |
| 2. Выберите необходимый часовой пояс или нажмите **использовать мой часовой пояс** (это установить в Админ-панели часовой пояс используемый на Вашем компьютере) | |
| - |  |
| + |  |
| 3. Нажмите сохранить | |
| /dev/null .. админ-панель/пользователи/настройки сотрудника/img-настройки сотрудника-2.png | |
| админ-панель/пользователи/сессии.md .. | |
| @@ 12,6 12,6 @@ | |
| 5. Укажите период, за который нужен список пользователей. | |
| 6. Нажмите на иконку XLS. | |
| - |  |
| + |  |
| Более подробную информацию о действиях пользователей и сотрудников, а именно истории действий с сущностями, можно получить в [системе мониторинга](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0) в соответствующих модулях и справочниках. | |
| админ-панель/пользователи/сессии/img-сессии-3.png .. /dev/null | |
| /dev/null .. админ-панель/пользователи/сессии/img-сессии.png | |
| админ-панель/пользователи/создание пользователя в админ-панели.md .. | |
| @@ 22,13 22,13 @@ | |
| В открывшейся форме выполните действия: | |
| 1. Введите **Имя** (При необходимости можете включить опцию "использовать как логин" - это позволит использовать имя пользователя вместо электронной почты при авторизации) | |
| - | 2. Введите адрес электронной почты пользователя; |
| - | 3. Введите пароль |
| - | 4. Выберите язык |
| + | 2. Введите **адрес электронной почты пользователя** |
| + | 3. Введите **пароль** |
| + | 4. Выберите **язык** |
| - |  |
| + |  |
| - | После заполнения необходимых полей перейдите в модуль **Компании**, здесь Вы сможете добавить пользователя в нужные Вам компании и выбрать для него **роль доступа**. |
| + | После заполнения необходимых полей перейдите в модуль **Компании**, здесь Вы сможете добавить пользователя в нужные Вам компании и выбрать для него **[роль пользователя](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0/%D1%80%D0%BE%D0%BB%D0%B8%20%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9)**. |
|  | |
| админ-панель/пользователи/создание пользователя в админ-панели/img-создание пользователя в админ-панели-1.png .. | |
| админ-панель/пользователи/создание пользователя в админ-панели/img-создание пользователя в админ-панели-2.png .. | |
| админ-панель/пользователи/создание пользователя в админ-панели/img-создание пользователя в админ-панели-3.png .. | |
| админ-панель/пользователи/создание пользователя в админ-панели/img-создание пользователя в админ-панели.png .. | |
| админ-панель/пользователи/создание сотрудника в админ-панели/img-создание сотрудника в админ-панели-1.png .. | |
| админ-панель/пользователи/создание сотрудника в админ-панели/img-создание сотрудника в админ-панели.png .. | |
| админ-панель/ретрансляции/лог ретрансляции.md .. | |
| @@ 19,6 19,6 @@ | |
| | IMEI | imei объекта по которому ведется ретрансляция | | |
| | Статус | статус сообщения (удачно - зелёный , неудачно - красный) | | |
| | Сообщение | Если сообщение слишком длинное, то строка обрезается и при нажатии на неё в подсказке отображается весь текст сообщения | | |
| - |  |
| + |  |
| При необходимости получить сообщения за определенный период, выбрав его в соответствующем поле. | |
| \ | No newline at end of file |
| админ-панель/ретрансляции/лог ретрансляции/img-лог ретрансляции-2.png .. /dev/null | |
| админ-панель/ретрансляции/лог ретрансляции/img-лог ретрансляции.png .. | |
| админ-панель/ретрансляции/ретрансляция исторических данных.md .. | |
| @@ 2,10 2,15 @@ | |
| Функционал для передачи данных ретрансляции за предыдущий период. Доступ имеют пользователи с ролью супервизор и редактор тарифа (Сотрудники интегратора и интегратор). | |
| Настраивается через модуль “Ретрансляции ИД” в [Админ-панели](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C). Можно создать новую ретрансляцию, или посмотреть уже завершённые. | |
| - | |
| ## Создание ретрансляции исторических данных | |
| - | Для создания нужно задать название, объект, период. Справа отображается список ретрансляций по imei этого объекта. Данные передаются на все, выбрать конкретную нельзя. |
| + | Для создания нужно: |
| + | |
| + | 1. Задать **название** |
| + | 2. Выбрать **объект** |
| + | 3. Ввести **период** |
| + | |
| + | Справа отображается список ретрансляций по imei этого объекта. Данные передаются на все, выбрать конкретную нельзя. |
|  | |
| @@ 16,6 21,6 @@ | |
| - В процессе | |
| - Ошибка | |
| - | Статус завершено - означает что закончился уставленный период ретрансляции или что вся история ушла на отправку. Зафиксировать, принял ли конечный получатель все данные нельзя. |
| + | Статус **завершено** - означает что закончился уставленный период ретрансляции или что вся история ушла на отправку. Зафиксировать, принял ли конечный получатель все данные нельзя. |
|  | |
| \ | No newline at end of file |
| админ-панель/ретрансляции/ретрансляция исторических данных/img-ретрансляция исторических данных-1.png .. | |
| админ-панель/ретрансляции/ретрансляция исторических данных/img-ретрансляция исторических данных.png .. | |
| админ-панель/роли доступа.md .. | |
| @@ 2,16 2,13 @@ | |
| В [админ-панели](/%D0%B0%D0%B4%D0%BC%D0%B8%D0%BD-%D0%BF%D0%B0%D0%BD%D0%B5%D0%BB%D1%8C) для интегратора и сотрудников интегратора существует возможность гибкой настройки ограничений доступа, через редактирование пользователей | |
| - | Роли делятся на: |
| + | [Роли](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0/%D1%80%D0%BE%D0%BB%D0%B8%20%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9) делятся на: |
| - Административные (роли сотрудников) - имеют доступ ко всем компаниям своего интегратора. | |
| - Пользовательские - имеют доступ только к определенным компаниям и действиям | |
| ## Роли сотрудников | |
| - Редактор Тарифа. Данной ролью обладают интеграторы системы SKIF.PRO, они могут создавать компании, пользователей, устанавливать и изменять тарифы своим компаниям, а также могут выполнять любые другие действия в системе без ограничений. | |
| - Супервизор. Роль для сотрудников интегратора. Она дает доступ пользователю к добавлению терминалов, а также, к админ-панели, в которой можно взаимодействовать со всеми объектами и компаниями интегратора. | |
| - | |
| - |  |
| - | |
| ## Роли пользователей | |
| - Администратор. Обладает максимальным уровнем прав внутри компании: Доступны все модули системы мониторинга, Доступно редактирование большинства справочников. Доступна тонкая настройка ролей доступа компании. Создание объектов и пользователей, а также назначение ролей пользователям (доступны администратору только в системе мониторинга). Админ-панель недоступна из системы мониторинга, только по прямой ссылке. | |
| @@ 21,6 18,4 @@ | |
| - Наблюдатель. Может просматривать отчеты, журнал, видит объекты в мониторинге. | |
| - Без доступа. Пользователь не имеет доступа к функционалу системы. Подходит для водителей, для добавления карточек водителя. | |
| - |  |
| - | |
| В [системе мониторинга](/%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0) так же есть возможность настройки собственных уникальных ролей доступа. | |
| \ | No newline at end of file |
| админ-панель/роли доступа/img-роли доступа-1.png .. /dev/null | |
| админ-панель/роли доступа/img-роли доступа-2.png .. /dev/null | |
| /dev/null .. открытое api.md | |
| @@ 0,0 1,278 @@ | |
| + | # **Открытый программный интерфейс (Open API v2.0)** |
| + | |
| + | Система спутникового мониторинга транспорта SKIF.PRO имеет открытое API для интеграции телематических данных и аналитики в любые сторонние корпоративные системы: 1С:Предприятие (УАТ, ERP), TMS/WMS логистические платформы, BI-системы и мобильные приложения. |
| + | |
| + | Интерактивное описание API и документация доступны по адресу: [https://api.skif.pro](https://api.skif.pro) (Swagger UI: [https://api.skif.pro/docs](https://api.skif.pro/docs)). |
| + | |
| + | Для выполнения интеграционных запросов и работы фоновых служб рекомендуется явно использовать выделенный рабочий сервер: **[https://app1.skif.pro/api_v1](https://app1.skif.pro/api_v1)**. |
| + | ## **Быстрые ссылки для разработчиков** |
| + | |
| + | | Ресурс | Описание | Ссылка | |
| + | |:---|:---|:---| |
| + | | **Портал API** | Официальный портал открытого программного интерфейса | [api.skif.pro](https://api.skif.pro) | |
| + | | **Swagger UI** | Интерактивная веб-песочница с описанием методов и возможностью тестирования | [api.skif.pro/docs](https://api.skif.pro/docs) | |
| + | | **Рабочий сервер API** | Рекомендуемый выделенный/резервный контур для интеграций и фоновых задач | `https://app1.skif.pro/api_v1` | |
| + | | **Postman-коллекция** | Готовая коллекция эндпоинтов со схемой переменных и примерами запросов | [Скачать коллекцию Postman v2.1](https://api.skif.pro/postman/SKIF_Platform_API_v2.json) | |
| + | | **OpenAPI 3.0 JSON** | Машиночитаемая спецификация для генерации клиентских библиотек (SDK) | [api.skif.pro/openapi.json](https://api.skif.pro/openapi.json) | |
| + | |
| + | --- |
| + | |
| + | ## **Быстрый старт: первые данные за 3 шага** |
| + | |
| + | Для отправки запросов используется базовый адрес: `https://app1.skif.pro/api_v1`. |
| + | |
| + | ### **Шаг 1. Авторизация и получение токена** |
| + | |
| + | Аутентификация в API выполняется запросом `POST /api_v1/login`: |
| + | |
| + | ```bash |
| + | curl -i -X POST "https://app1.skif.pro/api_v1/login" \ |
| + | -H "Content-Type: application/json" \ |
| + | -d '{ |
| + | "userProviderId": "your_login@company.ru", |
| + | "provider_key": "EMAIL", |
| + | "password": "your_password" |
| + | }' |
| + | ``` |
| + | |
| + | > **Важно**: При успешной авторизации (`HTTP 200`) тело ответа пустое, а токен авторизации возвращается **в HTTP-заголовке ответа**: |
| + | > `Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...` |
| + | |
| + | --- |
| + | |
| + | ### **Шаг 2. Первый запрос: Список объектов компании** |
| + | |
| + | Для всех последующих запросов передавайте полученный токен в заголовке `Authorization: Bearer <токен>`. **Использование сессионных cookies не требуется — API работает автономно по Bearer-токену.** |
| + | |
| + | ```bash |
| + | curl -X POST "https://app1.skif.pro/api_v1/units/list" \ |
| + | -H "Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9..." \ |
| + | -H "Content-Type: application/json" \ |
| + | -d '{ |
| + | "from": 0, |
| + | "count": 10 |
| + | }' |
| + | ``` |
| + | |
| + | **Пример ответа сервера:** |
| + | ```json |
| + | { |
| + | "max": 42, |
| + | "list": [ |
| + | { |
| + | "id": "3efbec79-a0b2-41aa-a859-cacd80323d2f", |
| + | "name": "Газель Next А102ВВ", |
| + | "device_type": "Navtelecom SMART S-2420", |
| + | "imei": "866795031900671" |
| + | } |
| + | ] |
| + | } |
| + | ``` |
| + | |
| + | --- |
| + | |
| + | ### **Шаг 3. Запрос телеметрии и текущего состояния ТС** |
| + | |
| + | Получение актуальных параметров объекта (координаты, скорость, зажигание, датчики уровня топлива): |
| + | |
| + | ```bash |
| + | curl -X GET "https://app1.skif.pro/api_v1/units?ids=3efbec79-a0b2-41aa-a859-cacd80323d2f" \ |
| + | -H "Authorization: Bearer <токен>" |
| + | ``` |
| + | |
| + | --- |
| + | |
| + | ## **Постоянный API-ключ компании (Static API Key)** |
| + | |
| + | Если вашей интеграции (например, серверу 1С или регулярному фоновому скрипту) неудобно регулярно вызывать логин и хранить динамические JWT-токены, администратор компании может выпустить постоянный токен доступа. |
| + | |
| + | 1. **Создание постоянного ключа** (выполняет администратор через API или веб-кабинет): |
| + | ```bash |
| + | POST https://app1.skif.pro/api_v1/users/:user_id/create_token |
| + | { |
| + | "valid_to": "2028-12-31 23:59:59" |
| + | } |
| + | ``` |
| + | В ответе возвращается ключ: `{"user_company_api_key": "YOUR_COMPANY_API_KEY"}`. |
| + | |
| + | 2. **Использование ключа**: |
| + | Передавайте данный ключ в любом запросе в заголовке `user_company_api_key`: |
| + | ```bash |
| + | curl -X POST "https://app1.skif.pro/api_v1/units/list" \ |
| + | -H "user_company_api_key: YOUR_COMPANY_API_KEY" \ |
| + | -H "Content-Type: application/json" \ |
| + | -d '{"from": 0, "count": 10}' |
| + | ``` |
| + | ## **Основные функциональные модули API** |
| + | |
| + | | Модуль | Ключевые методы | Возможности и типовые задачи | |
| + | |:---|:---|:---| |
| + | | **Объекты и датчики** | `POST /units/list`<br>`GET /units?ids=...`<br>`GET /unit_sensors/:id` | Реестр транспортных средств компании, установленные терминалы, счетчики пробега/моточасов, тарировочные таблицы баков. | |
| + | | **Пользователи и водители** | `POST /users/query`<br>`POST /users`<br>`POST /drivers/import_csv`<br>`POST /users/import_csv`<br>`PATCH /users/roles/bulk` | Справочник пользователей и водителей компании: фильтр по признаку водителя и ролям, быстрое создание водителя по ФИО, пакетный импорт водителей и пользователей из CSV, массовая смена роли. Водители используются для автоназначения на объекты по коду (RFID). | |
| + | | **Телеметрия и треки** | `POST /fasttracks`<br>`POST /fasttracks/bulk`<br>`GET /box_tracks` | Получение детализированных треков за интервал дат, сглаживание выбросов GPS, чтение сырых пакетов телеметрии. | |
| + | | **Поездки и стоянки** | `POST /report` (Шаблон «Поездки»)<br>`POST /chronology_report` | Детектор движения: расчет поездок, пробега, остановок и стоянок с определением адресов стоянок. | |
| + | | **Контроль топлива** | `POST /report` (Шаблон «Топливо»)<br>`GET /units/fuel_level` | Расход топлива по ДУТ и CAN-шине, детекция сливов и заправок с точным объемом в литрах. | |
| + | | **Геозоны и маршруты** | `GET /geozones`<br>`POST /geozones`<br>`POST /races/list` | Контроль входа/выхода из полигонов и окружностей, плановые маршруты и контроль соблюдения графика. | |
| + | | **События и тревоги** | `POST /events/list`<br>`POST /notifications` | Тревоги по превышению скорости, кнопке SOS, эвакуации, отключению питания трекера. Доставка через Webhooks / Telegram. | |
| + | | **Аналитические отчеты** | `POST /report`<br>`POST /report_excel` | Сводные ведомости по парку за период, экспорт готовых отчетов в Excel (`.xlsx`) и PDF. | |
| + | | **Интеграция с 1С** | `POST /units/list`<br>`POST /report` | Заполнение путевых листов 1С фактическим пробегом, расходом ГСМ и отработанными моточасами. | |
| + | ## **Стандарты взаимодействия, ограничения и производительность** |
| + | |
| + | ### **Выбор сервера** |
| + | - **Рабочий контур для интеграций (рекомендуется)**: `https://app1.skif.pro/api_v1`. |
| + | Использование сервера `app1.skif.pro` обеспечивает прямое и стабильное обслуживание API-интеграций и фоновых задач без конкуренции за пул сетевых соединений основного клиентского интерфейса. |
| + | - **Интерактивная документация**: `https://api.skif.pro` (Swagger: `https://api.skif.pro/docs`). |
| + | - **Тестовый контур**: `https://release.skif.pro/api_v1`. |
| + | |
| + | ### **Лимиты частоты запросов (Rate Limits)** |
| + | В сервисе авторизации платформы (`skif_auth`) действует автоматическая защита от перегрузки: |
| + | - **Базовый лимит**: **40 запросов в минуту** на учетную запись (по скользящему окну 60 секунд на каждый шаблон маршрута). |
| + | - **Лимит на метод `/login`**: до **40 запросов в минуту** с одного IP-адреса. |
| + | - **Код ответа при превышении лимита**: сервер возвращает `HTTP 429 Too Many Requests` со структурой: |
| + | ```json |
| + | { |
| + | "code": 4029, |
| + | "field": "", |
| + | "message": "Превышено количество отправленных запросов в минуту, подождите немного." |
| + | } |
| + | ``` |
| + | |
| + | ### **Рекомендации по паузам между запросами (Throttling)** |
| + | 1. **Интервал 300–600 мс**: После выполнения каждого запроса в цикле рекомендуется выдерживать паузу **300–600 мс** перед отправкой следующего вызова (особенно для ресурсоемких операций: выгрузка треков `POST /fasttracks`, расчет отчетов `POST /report`, построение хронологии `POST /chronology_report` или опрос расширенных данных по ТС). Это предотвращает случайное исчерпание лимита в 40 запросов в минуту и исключает взаимные блокировки при параллельной обработке. |
| + | 2. **Пакетная обработка (`bulk`)**: Вместо последовательного опроса каждого транспортного средства по отдельности используйте пакетные методы (например, `POST /fasttracks` поддерживает массив идентификаторов `units: [{"id": "..."}, ...]`). |
| + | 3. **Обработка ошибки 429**: При получении ответа `429` скрипт интеграции должен сделать экспоненциальную паузу (backoff) на 2–5 секунд перед повтором запроса. |
| + | |
| + | --- |
| + | |
| + | ## **Примеры кода** |
| + | |
| + | ### **Python: Получение списка ТС с обработкой пауз** |
| + | |
| + | ```python |
| + | import time |
| + | import requests |
| + | |
| + | # Рекомендуемый сервер для API интеграций |
| + | BASE_URL = "https://app1.skif.pro/api_v1" |
| + | |
| + | # 1. Авторизация |
| + | auth_resp = requests.post( |
| + | f"{BASE_URL}/login", |
| + | json={ |
| + | "userProviderId": "your_login@company.ru", |
| + | "provider_key": "EMAIL", |
| + | "password": "your_password" |
| + | }, |
| + | headers={"Content-Type": "application/json"} |
| + | ) |
| + | auth_resp.raise_for_status() |
| + | |
| + | # 2. Извлечение токена из заголовка ответа |
| + | token = auth_resp.headers.get("Authorization") |
| + | headers = { |
| + | "Authorization": token, |
| + | "Content-Type": "application/json", |
| + | "Accept": "application/json" |
| + | } |
| + | |
| + | # 3. Запрос списка транспортных средств |
| + | resp = requests.post( |
| + | f"{BASE_URL}/units/list", |
| + | headers=headers, |
| + | json={"from": 0, "count": 20} |
| + | ) |
| + | resp.raise_for_status() |
| + | |
| + | data = resp.json() |
| + | print(f"Всего объектов в парке: {data.get('max')}") |
| + | |
| + | for unit in data.get("list", []): |
| + | unit_id = unit["id"] |
| + | unit_name = unit["name"] |
| + | print(f"• ТС: {unit_name} (ID: {unit_id})") |
| + | |
| + | # Пауза 400-500 мс перед следующим тяжелым запросом телеметрии |
| + | time.sleep(0.5) |
| + | |
| + | telemetry_resp = requests.get( |
| + | f"{BASE_URL}/units?ids={unit_id}", |
| + | headers=headers |
| + | ) |
| + | if telemetry_resp.status_code == 200: |
| + | telemetry = telemetry_resp.json() |
| + | print(" Данные получены успешно.") |
| + | elif telemetry_resp.status_code == 429: |
| + | print(" Внимание: сработал лимит частоты, пауза 3 сек...") |
| + | time.sleep(3) |
| + | ``` |
| + | |
| + | ### **Node.js / JavaScript (Fetch API с паузой)** |
| + | |
| + | ```javascript |
| + | // Рекомендуемый сервер для API интеграций |
| + | const BASE_URL = 'https://app1.skif.pro/api_v1'; |
| + | |
| + | // Функция задержки между вызовами (300-600 мс) |
| + | const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)); |
| + | |
| + | async function runIntegration() { |
| + | // 1. Авторизация |
| + | const loginRes = await fetch(`${BASE_URL}/login`, { |
| + | method: 'POST', |
| + | headers: { 'Content-Type': 'application/json' }, |
| + | body: JSON.stringify({ |
| + | userProviderId: 'your_login@company.ru', |
| + | provider_key: 'EMAIL', |
| + | password: 'your_password' |
| + | }) |
| + | }); |
| + | |
| + | if (!loginRes.ok) throw new Error(`Login failed with status: ${loginRes.status}`); |
| + | |
| + | // Токен передается в HTTP-заголовке Authorization |
| + | const token = loginRes.headers.get('authorization'); |
| + | |
| + | // 2. Получение списка ТС |
| + | const listRes = await fetch(`${BASE_URL}/units/list`, { |
| + | method: 'POST', |
| + | headers: { |
| + | 'Authorization': token, |
| + | 'Content-Type': 'application/json' |
| + | }, |
| + | body: JSON.stringify({ from: 0, count: 10 }) |
| + | }); |
| + | |
| + | const listData = await listRes.json(); |
| + | console.log(`Всего объектов: ${listData.max}`); |
| + | |
| + | for (const unit of listData.list) { |
| + | console.log(`Объект: ${unit.name} (ID: ${unit.id})`); |
| + | |
| + | // Пауза 500 мс перед следующим запросом |
| + | await sleep(500); |
| + | |
| + | const unitRes = await fetch(`${BASE_URL}/units?ids=${unit.id}`, { |
| + | headers: { 'Authorization': token } |
| + | }); |
| + | |
| + | if (unitRes.status === 429) { |
| + | console.warn('Превышен лимит запросов, пауза 3 сек...'); |
| + | await sleep(3000); |
| + | } |
| + | } |
| + | } |
| + | |
| + | runIntegration().catch(console.error); |
| + | ``` |
| + | ## **Безопасность и лучшие практики** |
| + | |
| + | 1. **Защита учетных данных**: Не храните логин и пароль в открытом виде в исходном коде. Используйте переменные окружения или постоянный ключ `user_company_api_key`. |
| + | 2. **Кэширование токена**: Полученный JWT-токен действителен длительное время. Не вызывайте метод `/login` перед каждым отдельным запросом — сохраняйте полученный токен и обновляйте его только при ответе сервера `401 Unauthorized`. |
| + | 3. **Учет лимитов и таймаутов**: При интеграции с 1С настраивайте таймаут ожидания HTTP-соединения не менее 30–60 секунд для тяжелых аналитических отчетов и используйте интервалы 300–600 мс между последовательными запросами. |
| + | ## **Техническая поддержка интеграторов и обратная связь** |
| + | |
| + | Если вы обнаружили ошибку в работе методов, расхождение с документацией или у вас возник технический вопрос по интеграции: |
| + | |
| + | 1. **Форма обратной связи на портале API**: Нажмите кнопку **«Сообщить об ошибке»** в шапке документации [https://api.skif.pro](https://api.skif.pro). Заполните контур проблемы (боевой `app1.skif.pro` или стенд документации `api.skif.pro`), метод и ваш API-ключ компании. Обращение сразу поступит в очередь разработки. |
| + | 2. **Email техподдержки**: [support@skif.pro](mailto:support@skif.pro) (обязательно укажите тему вида `[API Issue] {Метод} - {Компания}`, ваш `company_id` и cURL вызова). |
| + | 3. **Персональный менеджер**: Обратитесь к вашему персональному менеджеру SKIF.PRO для согласования индивидуальных лимитов или выделенных вычислительных очередей. |
| \ | No newline at end of file |
