ChurchToolsAPI
Version 1.7.0
Beim Herunterladen des Quellcodes des Projekts muss standardmäßig eine config.py im Ordner „secure“ für die Standardausführung hinzugefügt werden. Bitte beachten Sie, dass dies vertrauliche Informationen beinhaltet und niemals an Dritte weitergegeben werden sollte und daher in Gitignore enthalten ist
Es sollte so aussehen:
# 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'}
Wenn Sie diesen Code als Python-Modul verwenden möchten, benötigen bestimmte Klassen Parameter ähnlich der Konfigurationsdatei, um auf Ihr System zuzugreifen
Die neueste Version finden Sie unter https://github.com/bensteUEM/ChurchToolsAPI/releases
Es kann mit pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' installiert werden, wobei XXX durch eine veröffentlichte Versionsnummer ersetzt wird
CT_TOKEN kann über die Option „Berechtigungen“ des Benutzers bezogen/geändert werden, der für den Zugriff auf die CT-Instanz verwendet werden soll. Es wird dringend empfohlen, einen benutzerdefinierten Benutzer mit minimalen Berechtigungen für die Verwendung mit diesem Modul einzurichten. Bitte überprüfen Sie jedoch die Protokolldateien und erwarten Sie unvollständige Ergebnisse, wenn dem Benutzer Berechtigungen fehlen.
Das Skript wurde zuletzt mit VS Code aktualisiert. Testfälle (z. B. von test_ChurchToolsApi.py) werden automatisch ausgeführt, wenn sie an GitHub übertragen werden. Dadurch wird sichergestellt, dass die Grundfunktionalität in mindestens einer Umgebung überprüft wird. Das Github Repo testet mit der Produktionsinstanz des Eigentümers, um sicherzustellen, dass die Daten für Tests übereinstimmen.
Bitte beachten Sie, dass für einige Testfälle bestimmte IDs auf dem CT-Server erforderlich sind, gegen den getestet wird. Die jeweilige Funktion verfügt über einen Hinweis wie den folgenden im Dokumentstring der jeweiligen Funktion
IMPORTANT - This test method and the parameters used depend on the target system!
Sie sind herzlich willkommen, mithilfe der entsprechenden Feature-Branches und Pull-Requests zusätzlichen Code beizusteuern. Neue Funktionen sollten immer entsprechende Testfälle beinhalten (die bei Merge-Anfrage an das automatisierte Testsystem angepasst werden können)+
Es gibt auch eine main.ipynb, mit der einzelne Aktionen schnell ausgeführt werden können, ohne ein separates Python-Projekt schreiben zu müssen
Getestet mit den aktuellen Churchtools-APIs ab September 2024 (CT 3.101). Weitere Informationen finden Sie auf den jeweiligen ChurchTools-Seiten.
https://IHRE_DOMAIN/api/
Neueste Zugriffsmethode – sollte für alles verwendet werden, was über diese API zugänglich ist. Die Dokumentation weiterer Endpunkte finden Sie unter der jeweiligen URL. Das Modul wurde entwickelt, um die spezifischen Anwendungsfälle aller Mitwirkenden zu unterstützen – einige Endpunkte sind möglicherweise noch nicht implementiert!
https://api.church.tools/index.html
Von der WebUI verwendete Legacy-API, die einige Endpunkte enthält, die noch nicht in die REST-API implementiert wurden. Einige Funktionen können mithilfe der Web-Developer Console zurückentwickelt werden, um Anforderungen zu überwachen. Die API kann sich ändern und funktioniert möglicherweise mit zukünftigen Versionen nicht mehr!
Es ist außerdem zeitaufwändiger als die REST-API, da es häufig große Datenmengen anstelle spezifischer Elemente abfragt.
Dieser Code wird mit einer CC-BY-SA-Lizenz bereitgestellt. Weitere Informationen finden Sie unter https://creativecommons.org/licenses/by-sa/2.0/.
Kurz gesagt bedeutet dies: Fühlen Sie sich frei, alles damit zu tun, ABER Sie sind verpflichtet, alle Änderungen oder zusätzlichen Funktionen zu veröffentlichen (auch wenn Sie die Funktionalität nur für sich selbst hinzufügen wollten!)
Jeder, der diesen Code verwendet, ist herzlich eingeladen, mit Änderungswünschen zum ursprünglichen Repository beizutragen.
