ChurchToolsAPI
Version 1.7.0
При загрузке исходного кода проекта по умолчанию необходимо добавить config.py в «безопасную» папку для выполнения по умолчанию. Имейте в виду, что это будет включать конфиденциальную информацию и никогда не должно передаваться третьим лицам, поэтому оно включено в gitignore.
Это должно выглядеть так:
# COMMENT FOR WHICH USER / DATE this is -> DO NOT SHARE
ct_domain = 'https://YOUR-DOMAIN.DE'
ct_token = 'TOKEN SECRET VERY LONG RANDOM STRING'
ct_users = {'USER_EMAIL': 'USER_PASSWORD'}
Если вы хотите использовать этот код в качестве модуля Python, для определенных классов потребуются параметры, аналогичные файлам конфигурации, для доступа к вашей системе.
Последнюю версию можно найти по адресу https://github.com/bensteUEM/ChurchToolsAPI/releases.
Его можно установить с помощью pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' заменив XXX номером выпущенной версии.
CT_TOKEN можно получить/изменить с помощью опции пользователя «Berechtigungen», которую следует использовать для доступа к экземпляру CT. Настоятельно рекомендуется настроить пользовательского пользователя с минимальными разрешениями для использования с этим модулем. Однако, пожалуйста, проверьте файлы журналов и ожидайте неполных результатов, если у пользователя нет разрешений.
Последний раз скрипт обновлялся с использованием VS Code. Тестовые случаи (например, из test_ChurchToolsApi.py) автоматически запускаются при отправке на GitHub. Это гарантирует, что базовая функциональность проверяется хотя бы в одной среде. Репозиторий Github проверяет соответствие производственному экземпляру владельца, чтобы обеспечить соответствие данных для тестов.
Имейте в виду, что для некоторых тестовых случаев требуются определенные идентификаторы на сервере CT, на котором проводится тестирование. Соответствующая функция имеет подсказку, подобную приведенной ниже, в строке документации соответствующих функций.
IMPORTANT - This test method and the parameters used depend on the target system!
Вы можете добавить дополнительный код, используя соответствующие ветки функций и запросы на включение. Новые функции всегда должны включать соответствующие тестовые сценарии (которые можно адаптировать к автоматизированной системе тестирования по запросу на слияние)+
Существует также файл main.ipynb, который можно использовать для быстрого выполнения отдельных действий без написания отдельного проекта Python.
Протестировано с текущими API-интерфейсами Churchtools по состоянию на сентябрь 2024 г. (CT 3.101). Более подробная информация представлена на соответствующих страницах ChurchTools.
https://ВАШ_ДОМЕН/api/
Самый последний метод доступа — следует использовать для всего, что доступно через этот API. Документацию по дополнительным конечным точкам можно найти, открыв соответствующий URL-адрес. Модуль был разработан для поддержки конкретных вариантов использования всеми участниками — некоторые конечные точки могут быть еще не реализованы!
https://api.church.tools/index.html
Устаревший API, используемый WebUI, который включает в себя некоторые конечные точки, которые еще не были реализованы в REST API. Некоторые функции можно реконструировать с помощью консоли веб-разработчика для мониторинга запросов. API может быть изменен и может перестать работать в любой будущей версии!
Это также требует больше времени, чем REST API, поскольку часто запрашивает большие наборы данных вместо конкретных элементов.
Этот код предоставляется с лицензией CC-BY-SA. Подробную информацию см. на https://creativecommons.org/licenses/by-sa/2.0/.
Вкратце это означает - не стесняйтесь делать с ним что угодно, НО вы обязаны публиковать любые изменения или дополнительные функции (даже если вы намеревались добавить функциональность только для себя!)
Любой, кто использует этот код, может внести свой вклад, отправив запросы на изменение исходного репозитория.
