Пачка Audit Events API Доступно только на тарифе «Корпорация»
Audit events API Пачки предоставляет командам безопасности доступ к логам о критически важных событиях в мессенджере. Это позволяет обеспечивать надежный мониторинг и соответствовать требованиям информационной безопасности и регуляторов.
Базовый URL
https://api.pachca.com/api/shared/v1/audit_events
Аутентификация
Все запросы к API журнала аудита требуют аутентификации с использованием OAuth-токена в заголовке Authorization:
Authorization: Bearer ВАШ_ТОКЕН
Примечание: API доступно только по токену владельца компании.
Метод
Запрос
|
||
---|---|---|
start_time | ISO 8601 |
Начальная метка времени (включительно), например,2025-05-01T09:11:00Z
|
end_time | ISO 8601 |
Конечная метка времени (исключительно), например,2025-05-02T09:11:00Z
|
event_key | Строка |
Фильтр по конкретному типу события, например,user_login
|
actor_id | Число | ID пользователя, выполнившего действие |
actor_type | Строка |
Тип актора, например,User
|
entity_id | Число | ID затронутой сущности |
entity_type | Строка |
Тип сущности, например,Chat
|
limit | Число |
Количество записей для возврата (по умолчанию:50 , максимум:50 )
|
cursor | Строка |
Курсор для пагинации из meta.paginate.next_page
|
{
"data": [
{
"id": "a1b2c3d4-5e6f-7g8h-9i10-j11k12l13m14",
"created_at": "2025-05-15T14:30:00.000Z",
"event_key": "user_chat_join",
"entity_id": "12345678",
"entity_type": "Chat",
"actor_id": "98765",
"actor_type": "User",
"details": {
"inviter_id": "45678"
},
"ip_address": "192.168.1.100",
"user_agent": "Pachca/3.60.0 (co.staply.pachca; build:15; iOS 18.5.0) Alamofire/5.0.0"
}
],
"meta": {
"paginate": {
"next_page": "eyJfa2QiOiJuIiwiY3JlYXRlZF9hdCI6IjIwMjUtMDUtMTUgMTQ6MzA6MDAuMDAwWiJ9"
}
}
}
Ответ
|
||
---|---|---|
200 | Успех | |
400 | Неверные параметры запроса | |
401 | Несанкционированный доступ | |
403 | Недостаточно прав | |
429 | Превышен лимит запросов |
Реализованные типы событий
В текущей версии API реализованы следующие типы событий:
user_login |
Пользователь успешно вошел в систему |
user_created |
Создана новая учетная запись пользователя | |
user_deleted |
Учетная запись пользователя удалена | |
user_role_changed |
Роль пользователя была изменена |
tag_created |
Создан новый тег | |
tag_deleted |
Тег удален | |
user_added_to_tag |
Пользователь добавлен в тег | |
user_removed_from_tag |
Пользователь удален из тега |
chat_created |
Создан новый чат | |
chat_renamed |
Чат переименован | |
chat_permission_changed |
Изменены права доступа к чату | |
user_chat_join |
Пользователь присоединился к чату | |
user_chat_leave |
Пользователь покинул чат | |
tag_added_to_chat |
Тег добавлен в чат | |
tag_removed_from_chat |
Тег удален из чата |
message_deleted |
Сообщение удалено |
audit_events_accessed |
Доступ к журналам аудита получен |
Примеры использования
curl --location 'https://api.pachca.com/api/shared/v1/audit_events' \
--header 'Authorization: ••••••' \
--data-urlencode 'start_time=2025-05-01T00:00:00Z' \
--data-urlencode 'end_time=2025-05-02T00:00:00Z' \
--data-urlencode 'event_key=user_login' \
--data-urlencode 'limit=50'
curl --location 'https://api.pachca.com/api/shared/v1/audit_events' \
--header 'Authorization: ••••••' \
--data-urlencode 'actor_id=133321' \
--data-urlencode 'actor_type=User' \
--data-urlencode 'start_time=2025-05-01T00:00:00Z' \
--data-urlencode 'end_time=2025-05-02T00:00:00Z'
curl --location 'https://api.pachca.com/api/shared/v1/audit_events' \
--header 'Authorization: ••••••' \
--data-urlencode 'event_key=chat_permission_changed' \
--data-urlencode 'start_time=2025-05-01T00:00:00Z' \
--data-urlencode 'end_time=2025-05-08T00:00:00Z'
Хранение данных
Журналы аудита хранятся в течение 90 дней для баланса между требованиями соответствия и эффективностью хранения. Все журналы неизменяемы и хранятся в системе только для чтения, чтобы обеспечить целостность данных.
Типичные сценарии использования
- Расследовать подозрительные попытки входа в систему
- Отслеживать изменения прав доступа
- Отслеживать действия по удалению сообщений
- Расследовать изменения ролей пользователей
- Отслеживать изменения в составе участников чатов
- Составлять отчеты о соответствии требованиям и во время аудита
Ограничения
- Текущая версия API поддерживает только типы событий, указанные в документации
- Данные собираются только с 12 мая 2025 года
- За один запрос можно запросить только один тип события
- Список событий и фильтры планируется развивать в следующих версиях.