Python
Асинхронный типизированный клиент для Pachca API. Построен на httpx с поддержкой type hints и dataclass-моделей. Требуется Python 3.10+.
Быстрый старт
Установка
Создание клиента
Получите API-токен в интерфейсе Пачки: Настройки → Автоматизации → API (подробнее — Авторизация).
Первый запрос
await внутри async def.Инициализация
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
token | str | — | Bearer-токен для авторизации |
base_url | str | https://api.pachca.com/api/shared/v1 | Базовый URL API |
Клиент использует httpx.AsyncClient — после завершения работы закройте его:
Все методы
| Метод | Метод API |
|---|---|
client.common.request_export() | POSTЭкспорт сообщений |
client.common.upload_file() | POSTЗагрузка файла |
client.common.get_upload_params() | POSTПолучение подписи, ключа и других параметров |
client.common.download_export() | GETСкачать архив экспорта |
client.common.list_properties() | GETСписок дополнительных полей |
client.profile.get_token_info() | GETИнформация о токене |
client.profile.get_profile() | GETИнформация о профиле |
client.profile.get_status() | GETТекущий статус |
client.profile.update_status() | PUTНовый статус |
client.profile.delete_status() | DELETEУдаление статуса |
client.users.create_user() | POSTСоздать сотрудника |
client.users.list_users() | GETСписок сотрудников |
client.users.get_user() | GETИнформация о сотруднике |
client.users.get_user_status() | GETСтатус сотрудника |
client.users.update_user() | PUTРедактирование сотрудника |
client.users.update_user_status() | PUTНовый статус сотрудника |
client.users.delete_user() | DELETEУдаление сотрудника |
client.users.delete_user_status() | DELETEУдаление статуса сотрудника |
client.group_tags.create_tag() | POSTНовый тег |
client.group_tags.list_tags() | GETСписок тегов сотрудников |
client.group_tags.get_tag() | GETИнформация о теге |
client.group_tags.get_tag_users() | GETСписок сотрудников тега |
client.group_tags.update_tag() | PUTРедактирование тега |
client.group_tags.delete_tag() | DELETEУдаление тега |
client.chats.create_chat() | POSTНовый чат |
client.chats.list_chats() | GETСписок чатов |
client.chats.get_chat() | GETИнформация о чате |
client.chats.update_chat() | PUTОбновление чата |
client.chats.archive_chat() | PUTАрхивация чата |
client.chats.unarchive_chat() | PUTРазархивация чата |
client.members.add_tags() | POSTДобавление тегов |
client.members.add_members() | POSTДобавление пользователей |
client.members.list_members() | GETСписок участников чата |
client.members.update_member_role() | PUTРедактирование роли |
client.members.remove_tag() | DELETEИсключение тега |
client.members.leave_chat() | DELETEВыход из беседы или канала |
client.members.remove_member() | DELETEИсключение пользователя |
client.threads.create_thread() | POSTНовый тред |
client.threads.get_thread() | GETИнформация о треде |
client.messages.create_message() | POSTНовое сообщение |
client.messages.pin_message() | POSTЗакрепление сообщения |
client.messages.list_chat_messages() | GETСписок сообщений чата |
client.messages.get_message() | GETИнформация о сообщении |
client.messages.update_message() | PUTРедактирование сообщения |
client.messages.delete_message() | DELETEУдаление сообщения |
client.messages.unpin_message() | DELETEОткрепление сообщения |
client.read_members.list_read_members() | GETСписок прочитавших сообщение |
client.reactions.add_reaction() | POSTДобавление реакции |
client.reactions.list_reactions() | GETСписок реакций |
client.reactions.remove_reaction() | DELETEУдаление реакции |
client.link_previews.create_link_previews() | POSTUnfurl (разворачивание ссылок) |
client.search.search_chats() | GETПоиск чатов |
client.search.search_messages() | GETПоиск сообщений |
client.search.search_users() | GETПоиск сотрудников |
client.tasks.create_task() | POSTНовое напоминание |
client.tasks.list_tasks() | GETСписок напоминаний |
client.tasks.get_task() | GETИнформация о напоминании |
client.tasks.update_task() | PUTРедактирование напоминания |
client.tasks.delete_task() | DELETEУдаление напоминания |
client.views.open_view() | POSTОткрытие представления |
client.bots.get_webhook_events() | GETИстория событий |
client.bots.update_bot() | PUTРедактирование бота |
client.bots.delete_webhook_event() | DELETEУдаление события |
client.security.get_audit_events() | GETЖурнал аудита событий |
Запросы
Все методы — асинхронные (async def) и возвращают корутины.
GET с параметрами:
POST с телом запроса:
Простой вызов по ID:
Пагинация
Методы, возвращающие списки, используют cursor-based пагинацию. Ответ содержит meta.paginate.next_page — курсор для следующей страницы.
Ручная пагинация
Автопагинация
Для каждого метода с пагинацией есть *_all() вариант:
Доступные методы автопагинации:
| Метод | Возвращает |
|---|---|
security.get_audit_events_all() | list[AuditEvent] |
bots.get_webhook_events_all() | list[WebhookEvent] |
chats.list_chats_all() | list[Chat] |
group_tags.list_tags_all() | list[GroupTag] |
group_tags.get_tag_users_all() | list[User] |
members.list_members_all() | list[User] |
messages.list_chat_messages_all() | list[Message] |
reactions.list_reactions_all() | list[Reaction] |
search.search_chats_all() | list[Chat] |
search.search_messages_all() | list[Message] |
search.search_users_all() | list[User] |
tasks.list_tasks_all() | list[Task] |
users.list_users_all() | list[User] |
Обработка ошибок
SDK выбрасывает два типа исключений:
ApiError
Возникает при ошибках 400, 403, 404, 409, 410, 422:
Поля ApiErrorItem:
| Поле | Тип | Описание |
|---|---|---|
key | str | Поле, вызвавшее ошибку |
value | str | None | Переданное значение |
message | str | Текст ошибки |
code | ValidationErrorCode | Код валидации |
payload | str | None | Дополнительные данные |
OAuthError
Возникает при ошибке авторизации (401):
Повторные запросы
SDK автоматически повторяет запрос при получении 429 Too Many Requests:
- До 3 повторов на каждый запрос
- Если сервер вернул заголовок
Retry-After— ждёт указанное время - Иначе — экспоненциальный backoff: 1 сек, 2 сек, 4 сек
- Реализовано через
RetryTransport— обёртку над httpx-транспортом
Типы
Все модели — Python dataclass'ы с type hints:
Зависимости
| Пакет | Версия | Назначение |
|---|---|---|
httpx | >=0.23.0 | Асинхронный HTTP-клиент |
attrs | >=22.2.0 | Dataclass'ы |
python-dateutil | ^2.8.0 | Парсинг дат |