Полный каталог служебных, прикладных и управляющих методов.
API ОДИСпро для интеграции с CRM, ERP, 1С и приложениями
Интерфейс ОДИСпро и внешние системы работают с ядром через один программный интерфейс. API создает и обновляет данные, читает журнал событий и позволяет проверить фактические права доступа.
Полная схема данных и методов ОДИСпро
Конкретный API-ключ получает только разрешенные ему методы и сущности. Цифры ниже показывают полный каталог MCP API ОДИСпро.
Данные объекта, доступа, транспорта, пользователей, событий и учета.
Уникальные имена полей и параметров в подробных схемах.
Типы, ограничения, обязательность и назначение параметров.
7 служебных методов
Подключение, поиск инструментов, сущности, поля, полные схемы и документированные связи.
69 методов чтения
Списки, карточки, состояния, журнал событий, мониторинг, отчеты и диагностика доступа.
83 метода
Создание, обновление, привязка, отвязка и другие разрешенные операции.
От подключения до проверенного результата
Клиент сначала получает доступную ему схему, затем вызывает точный метод и проверяет фактическое состояние данных.
- initializeИнициализировать MCP-сессию.
- mcp_setup_guideПолучить порядок действий для выбранного сценария.
- mcp_tablesУвидеть сущности и действия, разрешенные API-ключу.
- mcp_tool_schemaПолучить точную схему нужного метода.
- state / diagnoseПосле записи проверить связи и фактические права доступа.
API сам показывает доступные методы и их точные схемы
Статическая документация дает общую картину. Перед записью клиент получает актуальную схему непосредственно от MCP-сервера.
mcp_quickstartКраткий порядок подключения и базовые примеры вызовов.
mcp_setup_guideПошаговая настройка доступа, расписаний, сотрудников и автомобилей.
mcp_find_toolsПоиск нужного метода по задаче, модулю, действию или полю.
mcp_tablesСущности и действия, разрешенные текущему API-ключу.
mcp_fieldsПоля, типы, обязательность и ограничения выбранного действия.
mcp_tool_schemaПолная входная схема конкретного метода перед вызовом.
mcp_relationsДокументированные связи, необходимые для корректной записи данных.
JSON-RPC запросы
API-ключ передается только в HTTP-заголовке Authorization. Набор разрешенных методов зависит от прав ключа.
Получить пошаговую схему настройки
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "mcp_setup_guide",
"arguments": {"scenario": "vehicle_access"}
}
}Получить точную схему метода
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "mcp_tool_schema",
"arguments": {"name": "car_add"}
}
}Проверить возможность добавить автомобиль
{
"jsonrpc": "2.0",
"id": 3,
"method": "tools/call",
"params": {
"name": "car_check",
"arguments": {"anumber": "А111АА11"}
}
}Добавить гостевой автомобиль и выпустить ПИН-код
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "car_add",
"arguments": {
"fields": {
"anumber": "А111АА11",
"is_guest": 1,
"tm_end": "<YYYY-MM-DD HH:MM:SS>",
"request_pin": 1,
"request_pin_type": "controller"
}
}
}
}Создать временный допуск автомобилю
{
"jsonrpc": "2.0",
"id": 5,
"method": "tools/call",
"params": {
"name": "permit_add",
"arguments": {
"fields": {
"owner_card_id": "<UUID_ВЛАДЕЛЬЦА>",
"target_car_id": "<UUID_АВТОМОБИЛЯ>",
"permit_add_podr_id": "<UUID_ПОДРАЗДЕЛЕНИЯ>"
}
}
}
}Получить события проезда
{
"jsonrpc": "2.0",
"id": 6,
"method": "tools/call",
"params": {
"name": "history_list",
"arguments": {
"select": ["tm", "type", "value", "contr_id", "terr_id", "napr", "act", "txt"],
"from": 0,
"to": 100,
"order": {"tm": "DESC"}
}
}
}Обсудить интеграцию по API
Просто укажите телефон или почту, мы вам перезвоним.
Или позвоните: +7 343 385-77-07
36 разделов полной схемы API
mcp_tables возвращает только те сущности и действия, которые разрешены текущему Bearer-ключу.
Профили прав
accessПрава пользователей
Счета
billФинансы
Bluetooth-метки
btИдентификация
Автомобили
carТранспорт
Сотрудники
cardЛюди
Карты доступа
codeИдентификация
Компании
companyСтруктура объекта
Контроллеры
contrОборудование КПП
Договоры
contractДокументы
Группы
groupsОрганизация данных
Журнал событий
historyАудит проездов
Мониторинг
monitorСостояние объекта
Новости
newsКонтент
Гостевые ПИН-коды
npinГостевой доступ
Парковки
parkingПарковочный учет
Оплата парковки
parkpayПарковочные услуги
Партнеры
partnerКонтрагенты
Временные допуски
permitВременный доступ
Телефоны
phoneИдентификация
ПИН-коды
pinИдентификация
Подразделения
podrСтруктура объекта
Профили правил
pravНастройка доступа
Расписания
raspВремя доступа
Профили расписаний
raspaНазначение графиков
Отчеты
reportАналитика
Группы доступа
rghtПрава проезда
Правила
ruleЛогика доступа
Типы правил
ruledefСхемы проверки
Услуги
servicesСервисные операции
Статистика
statАналитика
Теги
tagsКлассификация
Территории
terrКПП и зоны
Часовые пояса
timezoneВремя объекта
Пользователи
userУчетные записи
Путевые листы
waybillТранспортные документы
Рабочее время
worktimeУчет времени
Все 159 методов MCP API
В таблице указаны назначение метода, раздел данных, тип операции и режим работы.
| Метод | Раздел | Операция | Описание | Режим |
|---|---|---|---|---|
mcp_quickstart | Служебные методы | схема API | Start here. Возвращает безопасный workflow: действия текущего Bearer-ключа, точные схемы, state до/после relation, car_check и access_diagnose. | чтение |
mcp_setup_guide | Служебные методы | схема API | Пошаговая настройка личного кабинета, прав, доступа, расписаний, сотрудников или автомобилей с учетом инструментов текущего Bearer-ключа. | чтение |
mcp_find_tools | Служебные методы | схема API | Найти подходящие инструменты по задаче, модулю, действию, названию, описанию или полям. Используйте перед бизнес-вызовом, если не знаете точный tool. | чтение |
mcp_relations | Служебные методы | схема API | Явные связи между таблицами и полями с точными attach/detach tools и post-check. Metadata описывает контракт, но не подтверждает наличие связи. | чтение |
mcp_fields | Служебные методы | схема API | Подробная схема полей одного модуля и действия. Вызывайте перед add/update/get/list/del/event. | чтение |
mcp_tool_schema | Служебные методы | схема API | Полная схема параметров одного инструмента. Вызывайте, если в минимальной схеме tool не хватает filter/from/to или подробных полей. | чтение |
mcp_tables | Служебные методы | схема API | Список модулей и действий, доступных текущему Bearer-ключу. | чтение |
access_list | Профили прав | список | Получить список всех профилей прав доступа с возможностью фильтрации по компании и активности. Используется для управления правами пользователей. | чтение |
access_get | Профили прав | получение | Получить данные прав по ID: название, поля доступа | чтение |
access_add | Профили прав | создание | Создать профиль прав. user_id заполняется сервером. Чтобы права начали действовать, привяжите профиль к groups, пользователя к той же groups и проверьте groups_state/user_access_state. | изменение |
access_update | Профили прав | изменение | Изменить существующий профиль прав доступа. Можно изменить название, активность и набор разрешений. Изменения применяются ко всем пользователям, привязанным к этому профилю. | изменение |
access_diagnose | Профили прав | диагностика | Проверяет сохраненный rght_access объекта после обычной API scope-проверки. Возвращает территории, контроллеры, группы, срок, источники назначения и состояние очереди пересчета по is_sync. | чтение |
bill_list | Счета | список | Получить список счетов | чтение |
bill_get | Счета | получение | Получить счет по ID | чтение |
bill_add | Счета | создание | Создать счет | изменение |
bt_list | Bluetooth-метки | список | Получить список Bluetooth-меток с фильтрацией по привязке и статусу. | чтение |
bt_add | Bluetooth-метки | создание | Создать новую Bluetooth-метку. Указать идентификатор метки и привязку к сотруднику или автомобилю. Компания определяется через привязанный объект. | изменение |
bt_update | Bluetooth-метки | изменение | Изменить статус активности, срок действия и комментарий Bluetooth-метки. | изменение |
car_list | Автомобили | список | Получить список всех автомобилей с фильтрацией по подразделению, сотруднику и статусу. Используется для управления автопарком. | чтение |
car_get | Автомобили | получение | Получить данные автомобиля по ID: госномер, компания, подразделение, сотрудник, статус, срок действия, привязанные группы доступа и пропуска. | чтение |
car_add | Автомобили | создание | Создать новую запись автомобиля. Указать госномер, подразделение, привязку к сотруднику. Можно сделать гостевым или установить срок действия. Компания определяется через подразделение. | изменение |
car_update | Автомобили | изменение | Изменить данные автомобиля: госномер, привязку к сотруднику, статус активности, срок действия. Подразделение изменить нельзя — оно определяет компанию. | изменение |
car_check | Автомобили | проверка | Проверяет эффективные возможности текущего пользователя: просмотр, добавление постоянного и гостевого авто. Отдельного guest_car_add нет: результат вычисляется из car_add и правил компании. Проверка номера ограничена доступным company scope. | чтение |
card_list | Сотрудники | список | Получить список всех сотрудников с фильтрацией по подразделению и статусу. Используется для управления персоналом и настройки прав. | чтение |
card_get | Сотрудники | получение | Получить данные карточки по ID: ФИО, компания, подразделение, статус, срок действия, привязанные автомобили и группы доступа. | чтение |
card_add | Сотрудники | создание | Создать новую карточку сотрудника. Указать ФИО, подразделение, компанию. Можно установить срок действия и гостевой режим. Компания определяется через подразделение. | изменение |
card_update | Сотрудники | изменение | Изменить данные сотрудника: ФИО, подразделение, статус активности, срок действия, гостевой режим. При обновлении обновляются все связанные группы доступа и пропуска. | изменение |
code_list | Карты доступа | список | Получить список всех карт доступа с фильтрацией по привязке и статусу. Используется для аудита и управления доступом. | чтение |
code_get | Карты доступа | получение | Получить данные карты по ID: код, привязка к сотруднику или автомобилю, статус, срок действия, тип (гость/постоянная). | чтение |
code_add | Карты доступа | создание | Создать новую карту доступа. Указать код карты (8 HEX-символов), привязку к сотруднику или автомобилю. Компания определяется через привязанный объект. | изменение |
code_update | Карты доступа | изменение | Изменить данные карты: привязку к сотруднику или автомобилю, статус активности, срок действия, гостевой режим. Обновление применяется мгновенно на всех контроллерах. | изменение |
company_list | Компании | список | Получить список всех компаний с фильтрацией по активности. Используется для выбора контекста при работе с подчинёнными объектами. | чтение |
company_get | Компании | получение | Получить полные данные компании по ID: настройки доступа, статус активности, дата создания, привязанные подразделения, права на управление объектами. | чтение |
company_add | Компании | создание | Создать новую компанию. Обязательное поле при создании — название. Реквизиты можно передать через API или заполнить после создания. | изменение |
company_update | Компании | изменение | Изменить настройки компании: название, ИНН, активность, права доступа (PIN, авто, карты), уведомления. Изменения применяются ко всем дочерним объектам (подразделениям, сотрудникам, автомобилям). | изменение |
contr_catalog | Контроллеры | каталог | Только список существующих контроллеров для выбора и проверки привязки к территории. MCP не изменяет контроллеры. | чтение |
contract_list | Договоры | список | Список договоров | чтение |
contract_get | Договоры | получение | Получить договор по ID | чтение |
contract_add | Договоры | создание | Создать договор по UUID из 1С | изменение |
contract_update | Договоры | изменение | Обновить договор | изменение |
groups_list | Группы пользователей | список | Получить список всех групп с фильтрацией по компании. Используется для управления правами пользователей. | чтение |
groups_get | Группы пользователей | получение | Получить данные группы по ID: название, компания, активность, привязанные пользователи и профили прав. | чтение |
groups_add | Группы пользователей | создание | Создать только запись группы пользователей. Пользователей и профили прав присоединяйте отдельными groups_*_attach инструментами. | изменение |
groups_update | Группы пользователей | изменение | Изменить только базовые параметры группы пользователей. Связи изменяйте отдельными groups_*_attach/detach инструментами. | изменение |
groups_state | Группы пользователей | состояние | Возвращает группу, видимых пользователей, профили прав и очередь пересчета. Используйте до и после изменения связей. | чтение |
groups_user_attach | Группы пользователей | привязка | Точный relation-инструмент. После операции вызовите groups_state; итоговые права пересчитываются очередью cron. | изменение |
groups_user_detach | Группы пользователей | отвязка | Точный relation-инструмент. После операции вызовите groups_state; итоговые права пересчитываются очередью cron. | изменение |
groups_access_attach | Группы пользователей | привязка | Точный relation-инструмент. После операции вызовите groups_state; итоговые права пользователей пересчитываются очередью cron. | изменение |
groups_access_detach | Группы пользователей | отвязка | Точный relation-инструмент. После операции вызовите groups_state; итоговые права пользователей пересчитываются очередью cron. | изменение |
history_list | История доступа | список | Получить список событий прохода/проезда с фильтрацией по дате, типу события (карта, автономер, PIN), направлению, объекту (сотрудник, авто), контроллеру или территории. Используется для аудита и расследования инцидентов. | чтение |
monitor_list | Мониторинг | список | Открыть основной монитор событий | чтение |
news_get | Новости | получение | Получить новость по ID: заголовок, текст, дата. | чтение |
news_add | Новости | создание | Создать новость: заголовок, текст, закрепить. | изменение |
news_update | Новости | изменение | Изменить заголовок, текст, закреп. | изменение |
npin_add | Временные PIN | создание | Создать новый гостевой пропуск. Указать название, сотрудника, компанию, количество пропусков, период действия. Можно сделать одноразовым или сгенерировать PIN-код. | изменение |
npin_update | Временные PIN | изменение | Изменить данные гостевого пропуска: название, период действия, количество, статус активности. Изменения применяются мгновенно. | изменение |
parking_list | Парковки | список | Получить список всех парковок с фильтрацией по территории. Используется для мониторинга заполненности. | чтение |
parking_get | Парковки | получение | Получить данные парковки по ID: название, территория, максимальное и текущее количество мест, статус. | чтение |
parking_add | Парковки | создание | Создать новую парковку. Указать название, территорию, максимальное количество мест. Используется для контроля заполненности парковочных зон. | изменение |
parking_update | Парковки | изменение | Изменить данные парковки: название, территорию, максимальное количество мест, статус активности. | изменение |
parkpay_list | Оплата парковки | список | Открыть список платных парковок | чтение |
parkpay_get | Оплата парковки | получение | Получить платную парковку по ID | чтение |
parkpay_add | Оплата парковки | создание | Создать платную парковку | изменение |
parkpay_update | Оплата парковки | изменение | Изменить платную парковку | изменение |
partner_add | Партнеры | создание | Создать партнера | изменение |
partner_update | Партнеры | изменение | Изменить партнера | изменение |
permit_list | Допуски автомобилей | список | Получить список временных допусков автомобилей | чтение |
permit_get | Допуски автомобилей | получение | Получить карточку временного допуска автомобиля | чтение |
permit_add | Допуски автомобилей | создание | Создать временный допуск. Требуются owner_card_id и ровно один target_card_id или target_car_id. Для реально применяемого допуска передайте подразделения через permit_podr или permit_add_podr_id. | изменение |
permit_update | Допуски автомобилей | изменение | Изменить временный допуск автомобиля | изменение |
permit_state | Допуски автомобилей | состояние | Возвращает владельца, получателя, подразделения с периодами, встречную связь и очередь пересчета. | чтение |
permit_check | Допуски автомобилей | проверка | Read-only проверка владельца, получателя, доступных подразделений, возможности встречного допуска и совпадающих активных допусков. | чтение |
phone_list | Телефоны | список | Получить список телефонов сотрудников с фильтрацией по сотруднику и активности. | чтение |
phone_get | Телефоны | получение | Получить телефон сотрудника по ID. | чтение |
phone_add | Телефоны | создание | Создать новый телефон сотрудника. card_id обязателен, company_id определяется сервером. | изменение |
phone_update | Телефоны | изменение | Изменить привязку, комментарий или активность телефона сотрудника. Номер телефона не меняется: отключите текущий телефон и добавьте новый. | изменение |
pin_list | PIN-коды | список | Получить список PIN-кодов с фильтрацией. | чтение |
pin_get | PIN-коды | получение | Получить данные PIN-кода по ID. | чтение |
pin_add | PIN-коды | создание | Создать PIN для ровно одного владельца card_id или car_id. Используйте request_pin_type=controller|dispenser и сначала вызовите pin_check. Успешный API-ответ не доказывает загрузку PIN на физический контроллер. | изменение |
pin_update | PIN-коды | изменение | Изменить PIN-код нельзя. Разрешено только переключение act. | изменение |
pin_check | PIN-коды | проверка | Read-only проверка владельца, правил режимов, эффективных контроллеров, лимитов и активных PIN. | чтение |
pin_dispenser_reset | PIN-коды | сброс | Отдельная операция сброса активных PIN диспенсера владельца. После вызова повторите pin_check. | изменение |
podr_list | Подразделения | список | Получить список всех подразделений с фильтрацией по компании. Используется для привязки сотрудников, автомобилей и настройки прав доступа. | чтение |
podr_get | Подразделения | получение | Получить данные подразделения по ID: название, компания, родитель, статус активности, вложенность. | чтение |
podr_add | Подразделения | создание | Создать новое подразделение. Указать название, компанию, родительское подразделение (для иерархии). Главное подразделение создаётся автоматически при создании компании. | изменение |
podr_update | Подразделения | изменение | Изменить данные подразделения: название, родительское подразделение (возможно перемещение в другую ветку), статус активности. | изменение |
prav_catalog | Профили правил | каталог | Безопасный список доступных профилей prav с типом и company scope. | чтение |
prav_state | Профили правил | состояние | Возвращает профиль и видимые привязанные сущности. Правила с enabled возвращаются только при наличии rule_list. Перед изменением и после него вызывайте повторно. | чтение |
prav_profile_create | Профили правил | создание | Создает только запись профиля. Поля relation сюда передавать нельзя; связи выполняются отдельными attach tools и проверяются через prav_state. | изменение |
prav_rule_attach | Профили правил | привязка | Точный relation-контракт prav/add: только prav_id и rule_id. Сервер повторно проверяет scope, тип и зависимость правила. | изменение |
prav_rule_detach | Профили правил | отвязка | Точный relation-контракт prav/del: удаляет связь с правилом и зависимые дочерние правила согласно бизнес-логике. | изменение |
prav_entity_attach | Профили правил | привязка | Точный relation-контракт prav/add: только prav_id и entity_id. Нельзя передавать entity_type: сервер вычисляет его по типу профиля. | изменение |
prav_entity_detach | Профили правил | отвязка | Точный relation-контракт prav/del: только prav_id и entity_id. Сервер вычисляет entity_type и проверяет scope. | изменение |
rasp_list | Расписания | список | Получить список всех расписаний с фильтрацией по типу. Используется для настройки временных ограничений доступа. | чтение |
rasp_get | Расписания | получение | Получить данные расписания по ID: название, тип, время начала и окончания, дни недели, статус. | чтение |
rasp_add | Расписания | создание | Создать расписание. Канонический payload интервалов — fields.items; каждый элемент требует type, tm_type, tm_from, tm_to, ui_state, is_work и act. | изменение |
rasp_update | Расписания | изменение | Изменить данные расписания: название, тип, время начала и окончания, дни недели, статус активности. | изменение |
raspa_get | Профили расписаний доступа | получение | Получить данные профиля расписания по ID. | чтение |
raspa_add | Профили расписаний доступа | создание | Создать только профиль расписания доступа. Связи с группами, территориями и сотрудниками выполняйте отдельными raspa_*_attach инструментами. | изменение |
raspa_update | Профили расписаний доступа | изменение | Изменить базовые параметры профиля расписания. Связи изменяйте отдельными raspa_*_attach/detach инструментами. | изменение |
raspa_list | Профили расписаний доступа | список | Read-only список профилей raspa. Использует прямой scope по company_id и не зависит от generic raspa/list runtime. | чтение |
raspa_state | Профили расписаний доступа | состояние | Возвращает профиль, расписание и видимые связи с группами доступа, территориями и сотрудниками. | чтение |
raspa_rght_attach | Профили расписаний доступа | привязка | Связь профиля расписания. После операции вызовите raspa_state; изменение физического доступа дополнительно проверяйте через rght_state/access_diagnose. | изменение |
raspa_rght_detach | Профили расписаний доступа | отвязка | Связь профиля расписания. После операции вызовите raspa_state; изменение физического доступа дополнительно проверяйте через rght_state/access_diagnose. | изменение |
raspa_terr_attach | Профили расписаний доступа | привязка | Связь профиля расписания. После операции вызовите raspa_state; изменение физического доступа дополнительно проверяйте через rght_state/access_diagnose. | изменение |
raspa_terr_detach | Профили расписаний доступа | отвязка | Связь профиля расписания. После операции вызовите raspa_state; изменение физического доступа дополнительно проверяйте через rght_state/access_diagnose. | изменение |
raspa_card_attach | Профили расписаний доступа | привязка | Связь профиля расписания. После операции вызовите raspa_state; изменение физического доступа дополнительно проверяйте через rght_state/access_diagnose. | изменение |
raspa_card_detach | Профили расписаний доступа | отвязка | Связь профиля расписания. После операции вызовите raspa_state; изменение физического доступа дополнительно проверяйте через rght_state/access_diagnose. | изменение |
report_add | Отчеты | создание | Создаёт новый пользовательский отчёт ODIS. Использовать, когда пользователь просит добавить, создать или сохранить новый отчёт. Для создания достаточно fields.name. report_json заполняется сервером или позже через update. | изменение |
report_update | Отчеты | изменение | Изменяет существующий пользовательский отчёт ODIS. Использовать для переименования отчёта или сохранения JSON-конфигурации отчёта в поле report_json. | изменение |
rght_list | Группы доступа | список | Получить список всех групп доступа с фильтрацией по типу и компании. Используется для настройки прав и аудита. | чтение |
rght_get | Группы доступа | получение | Получить данные группы доступа по ID: название, тип, компания, срок действия, привязанные территории и объекты. | чтение |
rght_add | Группы доступа | создание | Создать только группу доступа. Территории и объекты доступа привязывайте отдельными rght_terr_attach и rght_entity_attach, затем проверяйте rght_state и access_diagnose. | изменение |
rght_update | Группы доступа | изменение | Изменить только базовые параметры группы доступа. Территории и объекты доступа изменяйте отдельными rght_*_attach/detach инструментами. | изменение |
rght_state | Группы доступа | состояние | Возвращает базовые данные группы, видимые включенные территории и только те типы связанных объектов, списки которых разрешены пользователю. | чтение |
rght_terr_attach | Группы доступа | привязка | Вызывает rght/add с точным серверным payload fields.id=rght_id и fields.terr_id=terr_id. | изменение |
rght_terr_detach | Группы доступа | отвязка | Вызывает rght/del с точным relation payload. Не удаляет саму группу или территорию. | изменение |
rght_entity_attach | Группы доступа | привязка | Вызывает rght/add с точным payload fields.rght_id, fields.id=entity_id и fields.type=entity_type. | изменение |
rght_entity_detach | Группы доступа | отвязка | Вызывает rght/del с точным relation payload. Не удаляет объект или группу. | изменение |
rule_list | Правила | список | Получить список правил справочника. | чтение |
rule_get | Правила | получение | Получить правило по ID. | чтение |
rule_add | Правила | создание | Создать правило в справочнике. | изменение |
rule_update | Правила | изменение | Изменить правило в справочнике. | изменение |
rule_catalog | Правила | каталог | Возвращает доступные rule вместе с безопасной частью ruledef: типом, зависимостью и параметром. | чтение |
ruledef_list | Определения правил | список | Read-only список определений ruledef, доступных при включенных core-модулях. Запись ruledef через MCP не публикуется. | чтение |
services_list | Услуги | список | Открыть каталог услуг | чтение |
services_get | Услуги | получение | Получить услугу по ID | чтение |
services_add | Услуги | создание | Создать услугу или раздел | изменение |
services_update | Услуги | изменение | Изменить услугу или раздел | изменение |
stat_list | Статистика | список | Получить список готовых отчётов и статистических экранов. | чтение |
tags_list | Теги | список | Получить список тегов | чтение |
tags_get | Теги | получение | Получить тег по ID | чтение |
tags_add | Теги | создание | Создать новый тег | изменение |
tags_update | Теги | изменение | Изменить тег | изменение |
terr_list | Территории | список | Получить список всех территорий с фильтрацией по родителю. Используется для настройки инфраструктуры. | чтение |
terr_get | Территории | получение | Получить данные территории по ID: название, родитель, статус КПП, активность, привязанные контроллеры. | чтение |
terr_add | Территории | создание | Создать новую территорию. Указать название, родительскую территорию (опционально), пометить как КПП. Территория используется для привязки контроллеров и групп доступа. | изменение |
terr_update | Территории | изменение | Изменить данные территории: название, родительскую территорию, статус КПП, статус активности. Изменения применяются ко всем привязанным контроллерам. | изменение |
timezone_list | Временный доступ | список | Получить общий список временных зон по доступному scope. | чтение |
timezone_get | Временный доступ | получение | Открыть экран временных зон. | чтение |
timezone_add | Временный доступ | создание | Создать временный доступ для ровно одного субъекта card_id или car_id. Требуются rght_id, tm_from и tm_to. | изменение |
timezone_update | Временный доступ | изменение | Обновить черновик или активную временную зону. | изменение |
timezone_state | Временный доступ | состояние | Возвращает субъект, группу доступа, период, состояние, is_sync и текущую применимость. | чтение |
user_list | Пользователи | список | Получить список всех пользователей с фильтрацией по компании и статусу. Используется для управления доступом и аудита. | чтение |
user_get | Пользователи | получение | Получить данные пользователя по ID: логин, ФИО, компания, группа прав, статус активности, дата последнего входа. | чтение |
user_add | Пользователи | создание | Создать пользователя. Обычный сценарий требует login, name и pass. Автоматическая генерация пароля работает только при emailpass=1 и корректном email. Группа и профиль прав назначаются после создания через groups_user_attach и groups_access_attach. | изменение |
user_update | Пользователи | изменение | Изменить данные пользователя: ФИО, email, пароль, группу прав, статус активности. Только администратор (tree_view=1) может менять компанию или назначать права на управление компанией. | изменение |
user_access_state | Пользователи | состояние | Read-only состояние пользователя. Группы и профили ограничены их list/scope; рассчитанные флаги user_access возвращаются только при доступе к профилям access. Не выполняет запросы от имени пользователя. | чтение |
waybill_add | Путевые листы | создание | Добавить путевой лист | изменение |
waybill_update | Путевые листы | изменение | Обновить путевой лист | изменение |
worktime_list | Учет рабочего времени | список | Список профилей учета | чтение |
worktime_get | Учет рабочего времени | получение | Карточка профиля учета | чтение |
worktime_add | Учет рабочего времени | создание | Создать только профиль учета рабочего времени. Сотрудников и теги присоединяйте отдельными worktime_*_attach инструментами. | изменение |
worktime_update | Учет рабочего времени | изменение | Изменить профиль учета. Смена компании может удалить несовместимые связи. Связи изменяйте отдельными worktime_* инструментами. | изменение |
worktime_state | Учет рабочего времени | состояние | Возвращает профиль, расписание, прямых сотрудников, теги и фактически включенных сотрудников с источником связи. | чтение |
worktime_card_attach | Учет рабочего времени | привязка | После операции вызовите worktime_state. | изменение |
worktime_card_detach | Учет рабочего времени | отвязка | После операции вызовите worktime_state. | изменение |
worktime_tag_attach | Учет рабочего времени | привязка | После операции вызовите worktime_state. | изменение |
worktime_tag_detach | Учет рабочего времени | отвязка | После операции вызовите worktime_state. | изменение |
Обсудим данные, методы API и сценарий интеграции
КПП, направления, участники, правила, оборудование, интеграции и критерии приемки.