Skip to main content

ORM для работы с API РосДомофон

Project description

PyPI - Downloads PyPI - Downloads

rosdomofon.py

Документация росдомофона https://rdba.rosdomofon.com/swagger-ui.html#/

Назначение: Основной модуль для работы с API РосДомофон

Содержит:

  • Класс RosDomofonAPI с методами:
    • authenticate() - авторизация в системе
    • get_accounts() - получение всех аккаунтов
    • get_account_by_phone() - поиск аккаунта по номеру телефона
    • create_account() - создание нового аккаунта
    • create_flat() - создание квартиры
    • get_entrance_services() - получение услуг подъезда
    • connect_service() - подключение услуги
    • get_account_connections() - получение подключений аккаунта
    • get_service_connections() - получение подключений услуги
    • block_account() / unblock_account() - блокировка/разблокировка аккаунта
    • block_connection() / unblock_connection() - блокировка/разблокировка подключения
    • send_message() - отправка push-уведомлений (принимает словари или ID)
    • send_message_to_abonent() - упрощенная отправка сообщения по ID абонента
    • get_abonent_messages() - получение сообщений абонента
    • Kafka методы:
      • set_kafka_message_handler() - установка обработчика входящих Kafka сообщений
      • start_kafka_consumer() - запуск потребления сообщений из Kafka
      • stop_kafka_consumer() - остановка потребления сообщений
      • send_kafka_message() - отправка сообщения через Kafka
      • send_kafka_message_to_multiple() - групповая отправка через Kafka

Особенности:

  • Подробные docstring с примерами использования для каждого метода
  • Автоматическое логирование операций через loguru
  • Обработка ошибок HTTP запросов
  • Импорт моделей из отдельного файла models.py
  • Интегрированный Kafka клиент для real-time сообщений
  • Контекстный менеджер для автоматического закрытия соединений

kafka_client.py

Назначение: Клиент для работы с Kafka сообщениями РосДомофон

Содержит:

  • Класс RosDomofonKafkaClient с методами:
    • set_message_handler() - установка обработчика входящих сообщений
    • start_consuming() - запуск потребления в отдельном потоке
    • stop_consuming() - остановка потребления
    • send_message() - отправка сообщения одному абоненту
    • send_message_to_multiple() - отправка группового сообщения
    • close() - закрытие всех соединений

пример получения аккаунта по номеру телефона

account = api.get_account_by_phone(79308325215)
print(account)
print(account.owner.id) # abonent_id
print(account.id) # account_id

пример получения сообщений

messages = api.get_abonent_messages(abonent_id, channel='support', page=0, size=10)
print(messages)

пример отправки сообщения

api.send_message_to_abonent(abonent_id, 'support', f'вы написали {messages.content[0].message}')

Пример использования Kafka

Инициализация с Kafka поддержкой

api = RosDomofonAPI(
    username="user", password="pass",
    kafka_bootstrap_servers="kafka.example.com:9092",
    company_short_name="SK_SB"
)

Обработка входящих сообщений

def handle_message(message: KafkaIncomingMessage):
    print(f"Сообщение от {message.from_abonent.phone}: {message.message}")

api.set_kafka_message_handler(handle_message)
api.start_kafka_consumer()

Отправка через Kafka

api.send_kafka_message(1574870, 79308312233, "Ответ через Kafka")

short name company

для получения short name company нужно получить все аккаунты и найти short name company https://rdba.rosdomofon.com/abonents-service/api/v1/accounts

accounts = api.get_accounts()
for account in accounts:
    print(account.company.short_name)

company id

для получения company id нужно получить все аккаунты и найти company id

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rosdomofon-0.1.1.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rosdomofon-0.1.1-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file rosdomofon-0.1.1.tar.gz.

File metadata

  • Download URL: rosdomofon-0.1.1.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rosdomofon-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f12b33c51f3130661b6f760778364538b5b13308e4c963d239c6a30499f6f2e9
MD5 d17db70e1e1878725122aa3e74ff2508
BLAKE2b-256 6b18a2ed0731462d3999b3392438ab4255e82b5645618362baa5b15ae0145d3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for rosdomofon-0.1.1.tar.gz:

Publisher: python-publish.yml on darkClaw921/rosdomofon

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rosdomofon-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: rosdomofon-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rosdomofon-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd89fd203dd25a41775f3a828f04c3ac541386f9eeaaabfacfbe449259b8fdac
MD5 cfa7ba5d2bd82113aca5acf86eb40981
BLAKE2b-256 9c06eda123fe24b1b2c68146632a651f249ba8b874e76dc8760bf3cf37caf83d

See more details on using hashes here.

Provenance

The following attestation bundles were made for rosdomofon-0.1.1-py3-none-any.whl:

Publisher: python-publish.yml on darkClaw921/rosdomofon

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page