ChurchToolsAPI
Version 1.7.0
En téléchargeant le code source du projet par défaut, un config.py doit être ajouté dans le dossier "secure" pour une exécution par défaut. Veuillez noter que cela inclura des informations sensibles et ne devra jamais être partagée avec des tiers et est donc inclus dans gitignore.
Cela devrait ressembler à ceci :
# 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'}
Si vous souhaitez utiliser ce code comme module Python, certaines classes nécessiteront des paramètres similaires au fichier de configuration afin d'accéder à votre système.
La dernière version peut être trouvée sur https://github.com/bensteUEM/ChurchToolsAPI/releases
Il peut être installé en utilisant pip install git+https://github.com/bensteUEM/[email protected]#egg=churchtools-api' en remplaçant XXX par un numéro de version publié
CT_TOKEN peut être obtenu/modifié à l'aide de l'option "Berechtigungen" de l'utilisateur qui doit être utilisée pour accéder à l'instance CT. Il est fortement recommandé de configurer un utilisateur personnalisé avec des autorisations minimales pour une utilisation avec ce module. Cependant, veuillez vérifier les fichiers journaux et attendez-vous à des résultats incomplets si l'utilisateur manque d'autorisations.
Le script a été mis à jour pour la dernière fois à l'aide de VS Code. Les cas de test (par exemple à partir de test_ChurchToolsApi.py) sont automatiquement exécutés lorsqu'ils sont transmis à GitHub. Cela garantit que les fonctionnalités de base sont vérifiées par rapport à au moins un environnement. Le Github Repo effectue des tests par rapport à l'instance de production du propriétaire afin de garantir la correspondance des données pour les tests.
Veuillez noter que certains scénarios de test nécessitent que des identifiants spécifiques soient présents sur le serveur CT sur lequel le test est effectué. La fonction respective a un indice comme celui ci-dessous dans la docstring des fonctions respectives
IMPORTANT - This test method and the parameters used depend on the target system!
Vous êtes plus que bienvenu pour contribuer au code supplémentaire en utilisant les branches de fonctionnalités et les demandes d'extraction respectives. Les nouvelles fonctions doivent toujours inclure des cas de test respectifs (qui peuvent être adaptés au système de test automatisé sur demande de fusion)+
Il existe également un main.ipynb qui peut être utilisé pour exécuter rapidement des actions uniques sans écrire de projet Python séparé.
Testé par rapport aux API Churchtools actuelles en septembre 2024 (CT 3.101). Plus d’informations sont fournies sur les pages ChurchTools respectives.
https://VOTRE_DOMAINE/api/
Méthode d'accès la plus récente : doit être utilisée pour tout ce qui est accessible via cette API. La documentation des points de terminaison supplémentaires peut être trouvée en ouvrant l’URL correspondante. Le module a été développé pour prendre en charge les cas d'utilisation spécifiques de tous les contributeurs - certains points de terminaison pourraient ne pas encore être implémentés !
https://api.church.tools/index.html
API héritée utilisée par WebUI qui inclut certains points de terminaison qui n'ont pas encore été implémentés dans l'API REST. Certaines fonctions peuvent faire l'objet d'une ingénierie inverse à l'aide de Web-Developer Console pour surveiller les demandes. L'API est susceptible de changer et pourrait cesser de fonctionner avec n'importe quelle version future !
Cela prend également plus de temps que l'API REST car elle interroge souvent de grands ensembles de données au lieu d'éléments spécifiques.
Ce code est fourni avec une licence CC-BY-SA. Voir https://creativecommons.org/licenses/by-sa/2.0/ pour plus de détails.
En bref, cela signifie : n'hésitez pas à faire n'importe quoi avec MAIS vous devez publier toute modification ou fonctionnalité supplémentaire (même si vous aviez l'intention d'ajouter des fonctionnalités pour vous-même uniquement !)
Toute personne utilisant ce code est plus que bienvenue pour contribuer aux demandes de modification du référentiel d'origine.
